MythTV System Events

From MythTV Official Wiki
Revision as of 19:25, 8 March 2016 by Llib (talk | contribs) (Add LiveTV ended)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Software-update-available.png This page is up-to-date as of MythTV version 0.27.6, the current release is 31.0

This article describes the System Events page of MythTV Setup.

This is an optional setting and an advanced usage. You do not need to do anything here for basic recording and playback in MythTV.

MythTV System Events are a new feature in MythTV 0.23. Historically MythEvents have been used to communicate between components of the system when blocking was not required for proper operation. Now it is possible for the end user to tap into a number of events as well as defining up to ten keypress events. These events are handled by running an external script with appropriate parameters. MythTV System Events are configured on a per box basis so each machine can have it's own system specific handlers.

Beginning with release 0.26, timestamps of recordings are stored in UTC. Applications that use xxxTIME parameters to directly index the database will need to either handle timezone conversion internally, or switch to the respective xxxTIMEUTC parameters. See UTC.

Available Events

These are the currently defined events:

  • Any event
  • Client connected to master backend
  • Client disconnected from master backend
  • Keystroke event #1
  • Keystroke event #2
  • Keystroke event #3
  • Keystroke event #4
  • Keystroke event #5
  • Keystroke event #6
  • Keystroke event #7
  • Keystroke event #8
  • Keystroke event #9
  • Keystroke event #10
  • LiveTV started
  • LiveTV ended (0.28)
  • Master backend shutdown
  • Master backend started
  • mythfilldatabase ran
  • Network Control client connected
  • Network Control client disconnected
  • Playback paused
  • Playback program changed
  • Playback started
  • Playback stopped
  • Playback unpaused
  • Recording deleted
  • Recording expired
  • Recording finished
  • Recording pending
  • Recording started
  • Recording started writing
  • Scheduler ran
  • Screen created or destroyed
  • Settings cache cleared
  • Slave backend connected to master
  • Slave backend disconnected from master
  • System Event Command Editor

For each event you can optionally define a command that the system will run when that event occurs.

These events are all sent automatically when the appropriate condition is met, but it is also possible to send events from the command line, for example:

mythutil --systemevent USER_1

sends the first user event to whatever handler has been defined for that event.

Defining event handlers

Events handlers are edited in the System Events section in mythtv-setup. Select the event you would like to edit in the event list and then type in the script path and name followed by any parameters that you would like to pass to the script. For example to run a script whenever a recording is pending you could select the "Recording pending" event and type:

/opt/bin/ %STARTTIME%

That script could be a priming script to get a set top box out of it's sleep mode:

flock -x /tmp/chch.lock
echo "Sent priming shortly before %1" >> /tmp/priming-debug.log

Parameters available to event handlers

The parameters that it is possible to pass to an event depends on the event.

Parameters for System Events and User Jobs
Parameter Description Used




%CARDID% Event
%CATEGORY% Program subject category, may be undefined. Both
%CHANID% Channel ID Both
%DESCRIPTION% Program title, may be undefined. Both
%DIR% Event: myth://IP:6543/file.mpg, Job: actual directory, may be undefined prior to recording start. Both
%ENDTIME% Recording end time (estimated) yyyyMMddhhmmss. Both
%ENDTIMEUTC% yyyyMMddhhmmss Both
%EPISODE% Number Both 0.25?
%FILE% Recording file, may be undefined prior to recording start. Both
%FINDID% Find ID, for DB lookups. Event
%INETREF% String, e.g. ttvdb.py_123456
%JOBID% 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
%PLAYGROUP% Play group Both
%PROGEND% Program's scheduled end time. Both
%REACTIVATE% 1 if this recording was reactivated after failing to start on time, 0 otherwise. Event
%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
%SUBTITLE% Program subtitle, may be undefined. Both
%TITLE% Program title, may be undefined. Both
%TRANSPROFILE% Profile number. Job
%VERBOSELEVEL% Bit mapped decimal value. See: Both
%VERBOSEMODE% E.g.: --verbose --logpath --loglevel --quiet --nodblog [--syslog (if non Windows)]. Job 0.25

Note that not all parameters are available to all System Events User Jobs.

With time parameters, the first listed is in locale time & format suitable for user display, the second is in locale time & ISO format suitable for some scripts, the third is in UTC time & ISO format suitable for some script and generally preferred for scripts to avoid daylight savings issues. Parameters that may be undefined should be quoted to avoid parameter aliasing bugs.

Example Scripts

See the example scripts at Category:MythTV_System_Event_Scripts