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

From MythTV Official Wiki
Jump to: navigation, search
(Add Scope and Release columns)
(VERBOSELEVEL link to decode value)
(4 intermediate revisions by the same user not shown)
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 53: Line 55:
 
|yyyyMMddhhmmss
 
|yyyyMMddhhmmss
 
|Both
 
|Both
 +
|
 +
|-
 +
|%EPISODE%
 +
|Number
 +
|Both
 +
|0.25?
 +
|-
 +
|%EVENTNAME%
 +
|E.g. REC_PENDING
 +
|Event
 
|
 
|
 
|-
 
|-
Line 62: Line 74:
 
|%FINDID%
 
|%FINDID%
 
|Find ID, for DB lookups.
 
|Find ID, for DB lookups.
|
+
|Event
 
|
 
|
 
|-
 
|-
Line 68: Line 80:
 
|
 
|
 
|Both
 
|Both
 +
|
 +
|-
 +
|%INETREF%
 +
|String, e.g. ttvdb.py_123456
 +
|
 
|
 
|
 
|-
 
|-
Line 82: Line 99:
 
|%PARENTID%
 
|%PARENTID%
 
|Parent recording rule ID, for DB lookups.
 
|Parent recording rule ID, for DB lookups.
 +
|Event
 +
|
 +
|-
 +
|%PARTNUMBER%
 +
|Number
 +
|
 +
|
 +
|-
 +
|%PARTTOTAL%
 +
|Number
 
|
 
|
 
|
 
|
Line 132: Line 159:
 
|%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 169:
 
|%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
 
|
 
|
|
+
|-
 +
|%SEASON%
 +
|Number
 +
|Both
 +
|0.25?
 
|-
 
|-
 
|%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 188: Line 220:
 
|Program subtitle, may be undefined.
 
|Program subtitle, may be undefined.
 
|Both
 
|Both
 +
|
 +
|-
 +
|%#SYNDICATEDEPISODE%
 +
|String
 +
|
 
|
 
|
 
|-
 
|-
Line 193: Line 230:
 
|Program title, may be undefined.
 
|Program title, may be undefined.
 
|Both
 
|Both
 +
|
 +
|-
 +
|%TRANSPROFILE%
 +
|Profile number.
 +
|Job
 +
|
 +
|-
 +
|%#TOTALEPISODES%
 +
|Integer
 +
|
 
|
 
|
 
|-
 
|-
 
|%VERBOSELEVEL%
 
|%VERBOSELEVEL%
|Bit mapped decimal value.
+
|Bit mapped decimal value. See: https://code.mythtv.org/cgit/mythtv/tree/mythtv/libs/libmythbase/verbosedefs.h
 
|Both
 
|Both
 
|
 
|
 
|-
 
|-
 
|%VERBOSEMODE%
 
|%VERBOSEMODE%
|Passes: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
+
|E.g.: --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>

Revision as of 15:30, 19 April 2018


Usage:

{{Event and Job Parameters}}