Difference between revisions of "User Jobs"

From MythTV Official Wiki
Jump to: navigation, search
(Tell folks how to actually add a job, explain the options table)
Line 15: Line 15:
 
== User Job arguments ==
 
== User Job arguments ==
  
A user job is just a program or script which is passed some arguments to tell it what recording to perform work on. Either the channel and start time, or the directory and filename, should be sufficient to uniquely identify the recording. Any of the following four arguments can be used on the User Job:
+
A user job is just a program or script which is passed some arguments to tell it what recording to perform work on. Either the channel and start time, or the directory and filename, should be sufficient to uniquely identify the recording. Any of the following four arguments are useful for User Jobs:
  
 
{|border="1"
 
{|border="1"
Line 31: Line 31:
 
|%FILE%
 
|%FILE%
 
|The file name
 
|The file name
 +
|}
 +
 +
{|border="1"
 +
|+advanded User Job options
 +
|-
 +
|%TITLE%
 +
|-
 +
|-
 +
|%SUBTITLE%
 +
|-
 +
|-
 +
|%DESCRIPTION%
 +
|-
 +
|-
 +
|%HOSTNAME%
 +
|-
 +
|-
 +
|%CATEGORY%
 +
|-
 +
|-
 +
|%RECGROUP%
 +
|-
 +
|-
 +
|%PLAYGROUP%
 +
|-
 +
|-
 +
|%CHANID%
 +
|-
 +
|-
 +
|%STARTTIME%
 +
|In the format yyyyMMddhhmmss
 +
|-
 +
|%ENDTIME%
 +
|-
 +
|-
 +
|%STARTTIMEISO%
 +
|In the ISO date format YYYY-MM-DD hh:mm:ss
 +
|-
 +
|%ENDTIMEISO%
 +
|-
 +
|-
 +
|%PROGSTART%
 +
|-
 +
|-
 +
|%PROGEND%
 +
|-
 +
|-
 +
|%PROGSTARTISO%
 +
|-
 +
|-
 +
|%PROGENDISO%
 +
|-
 +
|-
 +
|%VERBOSELEVEL%
 +
|-
 
|}
 
|}
  
 
[[Category:HOWTO]]
 
[[Category:HOWTO]]

Revision as of 01:06, 31 March 2006

User Jobs are programs which can act on MythTV recordings. A MythTV system currently supports four User Jobs


Adding a User Job

There are two ways to add a User Job into the system:

1) In the mythtv-setup program

2) By using some SQL statements to insert the job directly (thanks to Jeremy Andrus for this). For example, a hypothetical job which edits bad language:

% mysql mythconverg
UPDATE settings SET data='/path/to/rm-swearing.sh %DIR%/%FILE%' WHERE value='UserJob1';
UPDATE settings SET data='Swearing Removal' WHERE value='UserJobDesc1';
UPDATE settings SET data='1' WHERE value='JobAllowUserJob1';

User Job arguments

A user job is just a program or script which is passed some arguments to tell it what recording to perform work on. Either the channel and start time, or the directory and filename, should be sufficient to uniquely identify the recording. Any of the following four arguments are useful for User Jobs:

options for User Jobs on the backend
%CHANID% Channel ID
%STARTTIME% Start Time of the Recording
%DIR% Path to the recording directory
%FILE% The file name
advanded User Job options
%TITLE%
%SUBTITLE%
%DESCRIPTION%
%HOSTNAME%
%CATEGORY%
%RECGROUP%
%PLAYGROUP%
%CHANID%
%STARTTIME% In the format yyyyMMddhhmmss
%ENDTIME%
%STARTTIMEISO% In the ISO date format YYYY-MM-DD hh:mm:ss
%ENDTIMEISO%
%PROGSTART%
%PROGEND%
%PROGSTARTISO%
%PROGENDISO%
%VERBOSELEVEL%