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

From MythTV Official Wiki
Jump to: navigation, search
(Add Scope and Release columns)
(Correct ISOUTC with trailing Z, added TRANSPROFILE)
 
Line 7: Line 7:
 
! scope="col" | Parameter
 
! scope="col" | Parameter
 
! scope="col" | Description
 
! scope="col" | Description
! scope="col" | Scope
+
! scope="col" | Used
 +
By
 
! scope="col" | Released
 
! scope="col" | Released
 +
In
 
|-
 
|-
 
|%CARDID%
 
|%CARDID%
 
|
 
|
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 31: Line 33:
 
|-
 
|-
 
|%DIR%
 
|%DIR%
|Recording directory, may be undefined prior to recording start.
+
|Event: myth://IP:6543/file.mpg, Job: actual directory, may be undefined prior to recording start.
|
+
|Both
 
|
 
|
 
|-
 
|-
Line 46: Line 48:
 
|-
 
|-
 
|%ENDTIMEISOUTC%
 
|%ENDTIMEISOUTC%
|YYYY-MM-DDThh:mm:ss
+
|YYYY-MM-DDThh:mm:ssZ
 
|
 
|
 
|
 
|
Line 62: Line 64:
 
|%FINDID%
 
|%FINDID%
 
|Find ID, for DB lookups.
 
|Find ID, for DB lookups.
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 82: Line 84:
 
|%PARENTID%
 
|%PARENTID%
 
|Parent recording rule ID, for DB lookups.
 
|Parent recording rule ID, for DB lookups.
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 132: Line 134:
 
|%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.
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 142: Line 144:
 
|%RECID%
 
|%RECID%
 
|Recording rule ID, for DB lookups.
 
|Recording rule ID, for DB lookups.
|
+
|Event
 
|
 
|
 
|-
 
|-
 
|%RECSTATUS%
 
|%RECSTATUS%
 
|Recording status as an integer for completeness, not currently useful.
 
|Recording status as an integer for completeness, not currently useful.
|
+
|Event
 
|
 
|
 
|-
 
|-
 
|%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.
|
+
|Event
 
|
 
|
 
|-
 
|-
 
|%SECS%
 
|%SECS%
 
|Time until upcoming recording starts.
 
|Time until upcoming recording starts.
|
+
|Event
 
|
 
|
 
|-
 
|-
 
|%SENDER%
 
|%SENDER%
 
|Origin of event (hostname.)
 
|Origin of event (hostname.)
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 193: Line 195:
 
|Program title, may be undefined.
 
|Program title, may be undefined.
 
|Both
 
|Both
 +
|
 +
|-
 +
|%TRANSPROFILE%
 +
|Profile number.
 +
|Job
 
|
 
|
 
|-
 
|-
Line 202: Line 209:
 
|%VERBOSEMODE%
 
|%VERBOSEMODE%
 
|Passes: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
 
|Passes: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
|User
+
|Job
 
|0.25
 
|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 System Events User Jobs.
 
</includeonly>
 
</includeonly>
 
<noinclude>
 
<noinclude>

Latest revision as of 01:13, 17 September 2012


Usage:

{{Event and Job Parameters}}