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

From MythTV Official Wiki
Jump to: navigation, search
(A single place for all system event and user job parameters)
 
(Use Event, not System typo)
 
(15 intermediate revisions by 2 users not shown)
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" | Used
 +
By
 +
! scope="col" | Released
 +
In
 +
|-
 +
|%CARDID%
 +
|
 +
|Event
 +
|
 
|-
 
|-
 
|%CATEGORY%
 
|%CATEGORY%
−
|-
+
|Program subject category, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%CHANID%
 
|%CHANID%
 
|Channel ID
 
|Channel ID
 +
|Both
 +
|
 
|-
 
|-
 
|%DESCRIPTION%
 
|%DESCRIPTION%
−
|-
+
|Program title, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 
|%DIR%
 
|%DIR%
−
|Path to the recording directory
+
|Event: myth://IP:6543/file.mpg, Job: actual directory, may be undefined prior to recording start.
 +
|Both
 +
|
 
|-
 
|-
 
|%ENDTIME%
 
|%ENDTIME%
−
|In the format yyyyMMddhhmmss
+
|Recording end time (estimated) yyyyMMddhhmmss.
 +
|Both
 +
|
 
|-
 
|-
 
|%ENDTIMEISO%
 
|%ENDTIMEISO%
−
|In the ISO date format YYYY-MM-DDThh:mm:ss
+
|YYYY-MM-DDThh:mm:ss
 +
|Both
 +
|
 +
|-
 +
|%ENDTIMEISOUTC%
 +
|YYYY-MM-DDThh:mm:ssZ
 +
|
 +
|
 
|-
 
|-
 
|%ENDTIMEUTC%
 
|%ENDTIMEUTC%
−
|In the format yyyyMMddhhmmss
+
|yyyyMMddhhmmss
 +
|Both
 +
|
 +
|-
 +
|%EPISODE%
 +
|Number
 +
|Both
 +
|0.25?
 +
|-
 +
|%EVENTNAME%
 +
|E.g. REC_PENDING
 +
|Event
 +
|
 
|-
 
|-
 
|%FILE%
 
|%FILE%
−
|The file name
+
|Recording file, may be undefined prior to recording start.
 +
|Both
 +
|
 +
|-
 +
|%FINDID%
 +
|Find ID, for DB lookups.
 +
|Event
 +
|
 
|-
 
|-
 
|%HOSTNAME%
 
|%HOSTNAME%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%INETREF%
 +
|String, e.g. ttvdb.py_123456
 +
|
 +
|
 
|-
 
|-
 
|%JOBID%
 
|%JOBID%
−
|The id of this job in the mythconverg jobqueue table
+
|The id of this job in the mythconverg jobqueue table.
 +
|
 +
|
 +
|-
 +
|%ORIGINALAIRDATE%
 +
|Original Air Date of recording.
 +
|Both
 +
|
 +
|-
 +
|%PARENTID%
 +
|Parent recording rule ID, for DB lookups.
 +
|Event
 +
|
 +
|-
 +
|%PARTNUMBER%
 +
|Number
 +
|
 +
|
 +
|-
 +
|%PARTTOTAL%
 +
|Number
 +
|
 +
|
 
|-
 
|-
 
|%PLAYGROUP%
 
|%PLAYGROUP%
−
|-
+
|Play group
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGEND%
 
|%PROGEND%
−
|-
+
|Program's scheduled end time.
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGENDISO%
 
|%PROGENDISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%PROGENDISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%PROGENDUTC%
 
|%PROGENDUTC%
−
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGSTART%
 
|%PROGSTART%
−
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%PROGSTARTISO%
 
|%PROGSTARTISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%PROGSTARTISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%PROGSTARTUTC%
 
|%PROGSTARTUTC%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%REACTIVATE%
 +
|1 if this recording was reactivated after failing to start on time, 0 otherwise.
 +
|Event
 +
|
 
|-
 
|-
 
|%RECGROUP%
 
|%RECGROUP%
 +
|Recording group
 +
|Both
 +
|
 +
|-
 +
|%RECID%
 +
|Recording rule ID, for DB lookups.
 +
|Event
 +
|
 +
|-
 +
|%RECORDEDID%
 +
|Recorded rule ID, for DB lookups.
 +
|Both
 +
|v29.2
 +
|-
 +
|%RECSTATUS%
 +
|Recording status as an integer for completeness, not currently useful.
 +
|Event
 +
|
 +
|-
 +
|%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.
 +
|Event
 +
|
 +
|-
 +
|%SEASON%
 +
|Number
 +
|Both
 +
|0.25?
 +
|-
 +
|%SECS%
 +
|Time until upcoming recording starts.
 +
|Event
 +
|
 
|-
 
|-
 +
|%SENDER%
 +
|Origin of event (hostname.)
 +
|Event
 +
|
 
|-
 
|-
 
|%STARTTIME%
 
|%STARTTIME%
−
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%STARTTIMEISO%
 
|%STARTTIMEISO%
 +
|
 +
|Both
 +
|
 
|-
 
|-
 +
|%STARTTIMEISOUTC%
 +
|
 +
|
 +
|
 
|-
 
|-
 
|%STARTTIMEUTC%
 
|%STARTTIMEUTC%
−
|-
+
|
 +
|Both
 +
|
 
|-
 
|-
 
|%SUBTITLE%
 
|%SUBTITLE%
 +
|Program subtitle, may be undefined.
 +
|Both
 +
|
 
|-
 
|-
 +
|%SYNDICATEDEPISODE%
 +
|String
 +
|
 +
|
 
|-
 
|-
 
|%TITLE%
 
|%TITLE%
 +
|Program title, may be undefined.
 +
|Both
 +
|
 +
|-
 +
|%TRANSPROFILE%
 +
|Profile number.
 +
|Job
 +
|
 
|-
 
|-
 +
|%TOTALEPISODES%
 +
|Integer
 +
|
 +
|
 +
|-
 +
|%VBIDEVICE%
 +
|E.g.: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
 +
|Event
 +
|30
 
|-
 
|-
 
|%VERBOSELEVEL%
 
|%VERBOSELEVEL%
 +
|Bit mapped decimal value. See: https://code.mythtv.org/cgit/mythtv/tree/mythtv/libs/libmythbase/verbosedefs.h
 +
|Both
 +
|
 
|-
 
|-
 +
|%VERBOSEMODE%
 +
|E.g.: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)].
 +
|Job
 +
|0.25
 
|-
 
|-
−
|%VERBOSEMODE%
+
|%VIDEODEVICE%
−
|Added in 0.25, passes: --verbose ... --logpath ... --loglevel ... --quiet --nodblog [--syslog ... (if non Windows)]
+
|String identifying the physical video device
−
|}
+
|Event
−
Note that not all parameters are available to all [[MythTV_System_Events|MythTV System Events]] or [[User_Jobs|User Jobs]].
+
|30
 +
|-
 +
}
 +
Note that not all parameters are available to all System Events User Jobs.
 
</includeonly>
 
</includeonly>
 
<noinclude>
 
<noinclude>

Latest revision as of 14:13, 25 February 2023


Usage: 

{{Event and Job Parameters}}
Retrieved from "http://www.mythtv.org/wiki?title=Template:Event_and_Job_Parameters&oldid=66465"