Difference between revisions of "Sweeper"

From hummy.tv Wiki
Jump to: navigation, search
(Available actions)
(Available actions)
Line 35: Line 35:
  
 
{| class="wikitable" style="border: 1px solid #ccc; cellspacing: 1, cellpadding: 5"
 
{| class="wikitable" style="border: 1px solid #ccc; cellspacing: 1, cellpadding: 5"
 +
|-
 +
! Action
 +
! Description
 +
! Parameter
 +
|-
 
! continue
 
! continue
| do nothing and continue to next rule.
+
| Do nothing and continue to next rule.
 +
| ''None''
 
|-  
 
|-  
 
! stop
 
! stop
| do nothing and stop processing rules.
+
| Do nothing and stop processing rules for this folder.
 +
| ''None''
 
|-
 
|-
 
! preserve
 
! preserve
| (deprecated) do nothing and stop processing rules.
+
| (deprecated - use ''stop'' instead) do nothing and stop processing rules.
 +
| ''None''
 
|-
 
|-
 
! lock
 
! lock
 
| Lock recording and continue to next rule.
 
| Lock recording and continue to next rule.
 +
| ''None''
 
|-
 
|-
 
! unlock
 
! unlock
 
| Unlock recording and continue to next rule.
 
| Unlock recording and continue to next rule.
 +
| ''None''
 
|-
 
|-
 
! move
 
! move
| move the recording to a folder.
+
| Move the recording to a folder.
 +
| Folder name relative to the system media root, e.g. (Films/Children)
 
|-
 
|-
 
! movecreate
 
! movecreate
 
| move the recording to a folder and create it if it doesn't exist.
 
| move the recording to a folder and create it if it doesn't exist.
 +
| Folder name relative to the system media root, e.g. (Films/Children)
 +
|-
 +
! rename
 +
| rename the recording and continue to the next rule. The argument will usually contain tokens that are replaced with values from the recording being processed.
 +
| New filename base (no extension) e.g. %title_%yyyymmdd_%hhmm
 
|-
 
|-
 
! fileunder
 
! fileunder
 
| Folders only; look for another existing with the same name as the new series recording and, if found, move the new recordings into it.
 
| Folders only; look for another existing with the same name as the new series recording and, if found, move the new recordings into it.
 +
| Folder name from which to start the search (e.g. Films) - leave blank to search from the top level.
 
|-
 
|-
 
! fileundercreate
 
! fileundercreate
 
| Folders only; as fileunder but if no folder is found then create a new one.
 
| Folders only; as fileunder but if no folder is found then create a new one.
 +
| | Folder name from which to start the search (e.g. Films) - leave blank to search from the top level.
 
|}
 
|}
  

Revision as of 09:45, 9 June 2014

Sweeper - the Swiss Army Knife of recording management

Available tokens

%genre Recording genre.
%definition Definition of recording (HD or SD).
%title Recording title.
%channel Channel name.
%lcn Logical channel number.
%duration Recording duration (in minutes).
%timestamp Recording start time as YYYYMMDDHHMMSS.
%yyyymmmdd Recording start time as YYYYMMDD.
%hhmm Recording start time as HHMM

Available actions

Action Description Parameter
continue Do nothing and continue to next rule. None
stop Do nothing and stop processing rules for this folder. None
preserve (deprecated - use stop instead) do nothing and stop processing rules. None
lock Lock recording and continue to next rule. None
unlock Unlock recording and continue to next rule. None
move Move the recording to a folder. Folder name relative to the system media root, e.g. (Films/Children)
movecreate move the recording to a folder and create it if it doesn't exist. Folder name relative to the system media root, e.g. (Films/Children)
rename rename the recording and continue to the next rule. The argument will usually contain tokens that are replaced with values from the recording being processed. New filename base (no extension) e.g. %title_%yyyymmdd_%hhmm
fileunder Folders only; look for another existing with the same name as the new series recording and, if found, move the new recordings into it. Folder name from which to start the search (e.g. Films) - leave blank to search from the top level.
fileundercreate Folders only; as fileunder but if no folder is found then create a new one. Folder name from which to start the search (e.g. Films) - leave blank to search from the top level.

Available conditions

flag A flag against the recording, e.g. 'flag New'. Flags are Locked, New, Encrypted, Guidance, ODEncrypted, Shrunk, Deduped.
lcn Logical channel number, e.g. 'lcn 1', 'lcn {> 1}'
duration Recording duration in minutes, e.g. 'duration {> 60}'
schedduration Scheduled recording duration in minutes.
size Size in bytes
age Age in hours (measured from recording end time).
wage Number of hours since last watched, or from recording end time if not watched.
definition Standard (SD) or high (HD) definition, e.g. 'definition SD'
title Title contains ..., e.g. 'title {The Big Bang Theory}'
synopsis Synopsis contains ...
guidance Guidance contains ...
genre Recording genre is.. e.g. 'genre Children'
hour Hour of recording, e.g. 'hour {>= 21}'