Difference between revisions of "Template:Event and Job Parameters"

From MythTV Official Wiki
Jump to: navigation, search
(Merge system events)
(Add Scope and Release columns)
Line 1: Line 1:
 
<includeonly>
 
<includeonly>
 
__NOCACHE__
 
__NOCACHE__
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:silver; background:whitesmoke"
+
{| border="1" cellspacing="0" cellpadding="5" style="float: right; border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
 +
|- style="background-color: lightsteelblue;"
 
|+ '''Parameters for System Events and User Jobs'''
 
|+ '''Parameters for System Events and User Jobs'''
|- style="background: gainsboro"
+
|- style="background-color: lightsteelblue;"
! Parameter !! Description
+
! scope="col" | Parameter
 +
! scope="col" | Description
 +
! scope="col" | Scope
 +
! scope="col" | Released
 
|-
 
|-
 
|%CARDID%
 
|%CARDID%
 +
|
 +
|
 
|
 
|
 
|-
 
|-
 
|%CATEGORY%
 
|%CATEGORY%
|Program subject category, may be undefined
+
|Program subject category, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%CHANID%
 
|%CHANID%
 
|Channel ID
 
|Channel ID
 +
|Both
 +
|
 
|-
 
|-
 
|%DESCRIPTION%
 
|%DESCRIPTION%
|Program title, may be undefined
+
|Program title, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%DIR%
 
|%DIR%
|Recording directory, may be undefined prior to recording start
+
|Recording directory, may be undefined prior to recording start.
 +
|
 +
|
 
|-
 
|-
 
|%ENDTIME%
 
|%ENDTIME%
|Recording end time (estimated) yyyyMMddhhmmss
+
|Recording end time (estimated) yyyyMMddhhmmss.
 +
|Both
 +
|
 
|-
 
|-
 
|%ENDTIMEISO%
 
|%ENDTIMEISO%
 
|YYYY-MM-DDThh:mm:ss
 
|YYYY-MM-DDThh:mm:ss
 +
|Both
 +
|
 +
|-
 +
|%ENDTIMEISOUTC%
 +
|YYYY-MM-DDThh:mm:ss
 +
|
 +
|
 
|-
 
|-
 
|%ENDTIMEUTC%
 
|%ENDTIMEUTC%
 
|yyyyMMddhhmmss
 
|yyyyMMddhhmmss
 +
|Both
 +
|
 
|-
 
|-
 
|%FILE%
 
|%FILE%
|Recording file, may be undefined prior to recording start
+
|Recording file, may be undefined prior to recording start.
 +
|Both
 +
|
 
|-
 
|-
 
|%FINDID%
 
|%FINDID%
|Find ID, for DB lookups
+
|Find ID, for DB lookups.
 +
|
 +
|
 
|-
 
|-
 
|%HOSTNAME%
 
|%HOSTNAME%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%JOBID%
 
|%JOBID%
|The id of this job in the mythconverg jobqueue table
+
|The id of this job in the mythconverg jobqueue table.
 +
|
 +
|
 
|-
 
|-
 
|%ORIGINALAIRDATE%
 
|%ORIGINALAIRDATE%
|Original Air Date of recording
+
|Original Air Date of recording.
 +
|Both
 +
|
 
|-
 
|-
 
|%PARENTID%
 
|%PARENTID%
|Parent recording rule ID, for DB lookups
+
|Parent recording rule ID, for DB lookups.
 +
|
 +
|
 
|-
 
|-
 
|%PLAYGROUP%
 
|%PLAYGROUP%
 
|Play group
 
|Play group
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGEND%
 
|%PROGEND%
|Program's scheduled end time
+
|Program's scheduled end time.
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGENDISO%
 
|%PROGENDISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%PROGENDISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%PROGENDUTC%
 
|%PROGENDUTC%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGSTART%
 
|%PROGSTART%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGSTARTISO%
 
|%PROGSTARTISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%PROGSTARTISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%PROGSTARTUTC%
 
|%PROGSTARTUTC%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%REACTIVATE%
 
|%REACTIVATE%
 
|1 if this recording was reactivated after failing to start on time, 0 otherwise.
 
|1 if this recording was reactivated after failing to start on time, 0 otherwise.
 +
|
 +
|
 
|-
 
|-
 
|%RECGROUP%
 
|%RECGROUP%
 
|Recording group
 
|Recording group
 +
|Both
 +
|
 
|-
 
|-
 
|%RECID%
 
|%RECID%
|Recording rule ID, for DB lookups
+
|Recording rule ID, for DB lookups.
 +
|
 +
|
 
|-
 
|-
 
|%RECSTATUS%
 
|%RECSTATUS%
 
|Recording status as an integer for completeness, not currently useful.
 
|Recording status as an integer for completeness, not currently useful.
 +
|
 +
|
 
|-
 
|-
 
|%RECTYPE%
 
|%RECTYPE%
 
|This is the recording rule type as an integer, in the priming script example this could be used to do an extensive priming prior to some recordings and not others. These integers are listed in recordingtypes.h in the RecordingType enum.
 
|This is the recording rule type as an integer, in the priming script example this could be used to do an extensive priming prior to some recordings and not others. These integers are listed in recordingtypes.h in the RecordingType enum.
 +
|
 +
|
 
|-
 
|-
 
|%SECS%
 
|%SECS%
|Time until upcoming recording
+
|Time until upcoming recording starts.
 +
|
 +
|
 
|-
 
|-
 
|%SENDER%
 
|%SENDER%
|Origin of event
+
|Origin of event (hostname.)
 +
|
 +
|
 
|-
 
|-
 
|%STARTTIME%
 
|%STARTTIME%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%STARTTIMEISO%
 
|%STARTTIMEISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%STARTTIMEISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%STARTTIMEUTC%
 
|%STARTTIMEUTC%
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%SUBTITLE%
 
|%SUBTITLE%
|Program subtitle, may be undefined
+
|Program subtitle, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%TITLE%
 
|%TITLE%
|Program title, may be undefined
+
|Program title, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%VERBOSELEVEL%
 
|%VERBOSELEVEL%
|-
+
|Bit mapped decimal value.
 +
|Both
 +
|
 
|-
 
|-
 
|%VERBOSEMODE%
 
|%VERBOSEMODE%
|New in 0.25, passes: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)]
+
|Passes: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
 +
|User
 +
|0.25
 
|}
 
|}
 
Note that not all parameters are available to all [[MythTV_System_Events|MythTV System Events]] or [[User_Jobs|User Jobs]].
 
Note that not all parameters are available to all [[MythTV_System_Events|MythTV System Events]] or [[User_Jobs|User Jobs]].

Revision as of 22:00, 16 September 2012


Usage:

{{Event and Job Parameters}}