Difference between revisions of "Mythutil"

From MythTV Official Wiki
Jump to: navigation, search
(Created page with ''''MythUtil''' is a command line application added in MythTV 0.25 that offers a number of utilities previously offered elsewhere as secondary functions. == Backend Triggers == T…')
 
m (--gencutlist: spelling)
 
(One intermediate revision by one user not shown)
Line 23: Line 23:
  
 
=== --clearcutlist ===
 
=== --clearcutlist ===
 +
Remove any currently defined cut points for the specified recording.
 +
 
=== --clearskiplist ===
 
=== --clearskiplist ===
 +
Remove any commercial detection results for the specified recording.
 +
 
=== --gencutlist ===
 
=== --gencutlist ===
 +
Move the commercial detection results into a cut list. 
 +
{{warning box|Any transcode performed at this point will permanently apply the commercial detection results without manual verification by the user. The default behavior is not to do this, as the commercial detection routines are not believed to be 100% accurate.}}
 +
 
=== --getcutlist ===
 
=== --getcutlist ===
 +
Return the currently defined cut list as a comma-separated list of ranges.  Use '''''-q''''' to hide unwanted logging and return only the cut list.
 +
 
=== --getskiplist ===
 
=== --getskiplist ===
 +
Return the currently defined commercial detection results as a comma-separated list of ranges.  Use '''''-q''''' to hide unwanted logging and return only the cut list.
 +
 
=== --setcutlist ===
 
=== --setcutlist ===
 +
Apply a provided comma-separate list of ranges to the specified recording.
 +
 
=== --setskiplist ===
 
=== --setskiplist ===
 +
Apply a provided commercial detection list of ranges to the specified recording.
  
 
== File Operations ==
 
== File Operations ==
 
=== --copyfile ===
 
=== --copyfile ===
 +
Copy one file or myth:// URI to another. Requires '''''--infile''''' and '''''--outfile'''''.
  
 
== Messaging Access ==
 
== Messaging Access ==
 +
These options are used to send popups to any available [[mythfrontend]] instance using the [[MythMessage]] interface.
 +
 
=== --print-template ===
 
=== --print-template ===
 +
Display the default [[MythMessage]] template to use.  The current default template is:
 +
<pre>
 +
<mythmessage version="1">
 +
  <text>%message_text%</text>
 +
  <timeout>%timeout%</timeout>
 +
</mythmessage>
 +
</pre>
 +
 
=== --message ===
 
=== --message ===
 +
Send selected template using provided replacement text. The template will have several fields listed, that can be replaced using additional command line options of that name.  In the above template, one would use '''''--message_text''''' and '''''--timeout'''''.
 +
 +
=== --bcastaddr ===
 +
Select the address to send message to.  The default value is 127.0.0.1 for the local host.  Sending to your subnet broadcast address will display the message on any active [[Mythfrontend|frontend]].
 +
 +
=== --udpport ===
 +
Select the port to send to.  The default is 6548.
  
 
== MPEG-TS Information ==
 
== MPEG-TS Information ==
 +
These options are used to display stream information about MPEG recordings.
 +
 
=== --pidcounter ===
 
=== --pidcounter ===
 +
Count the number of PIDs found in a recording.  Requires '''''--infile''''', which can be a relative or absolute file path, or a myth:// URI.  Optionally accepts a '''''--packetsize''''', which defaults to 188 bytes.
 +
 
=== --pidfilter ===
 
=== --pidfilter ===
 +
Apply PID filter to a recording, and output the resulting MPEG video to a new file.  Requires '''''--infile''''' and '''''--outfile''''', which can be relative or absolute file paths, or myth:// URIs.  Requires '''''--pids''''' for the filter to apply.  Optionally accepts a '''''--packetsize''''', which defaults to 188 bytes.
 +
 
=== --pidprinter ===
 
=== --pidprinter ===
 +
Output the available PIDs found in a recording.  Requires '''''--infile''''', which can be a relative or absolute file path, or a myth:// URI.  Requires '''''--pids''''' for the filter to select for.  Optionally accepts '''''--outfile''''', '''''--xml''''', and '''''--noautopts'''''.
 +
 
=== --ptspids ===
 
=== --ptspids ===
  
 
== JobQueue Operations ==
 
== JobQueue Operations ==
 
=== --queuejob ===
 
=== --queuejob ===
 +
Schedule a job of the specified type to be run through the jobqueue.  Requires the use of '''''--chanid''''' and '''''--starttime'''''.
  
 
[[Category:MythTV_Software]]
 
[[Category:MythTV_Software]]
 
[[Category:Glossary]]
 
[[Category:Glossary]]

Latest revision as of 23:33, 14 May 2012

MythUtil is a command line application added in MythTV 0.25 that offers a number of utilities previously offered elsewhere as secondary functions.

Backend Triggers

The options tell the master backend to perform some action

--clearcache

Issue an event that gets forwarded to any connected MythTV application that they should clear their database settings cache and pull new values as needed.

--resched

Force the scheduler to rerun, and update the internal list of upcoming recordings, after having made some changes to the recording rules.

--scanvideos

Scan through all defined Videos storage directories on all available hosts for content to import into the Video Library. This is intended to allow UPnP users to update their libraries without having to run mythfrontend and trigger one through the UI.

--event

Issue an arbitrary message through the event system that gets forwarded to any connected MythTV application.

--systemevent

Issue an arbitrary message as a System Event that gets forwarded once to each host running a connected MythTV application.

Markup Utilities

These allow you to manipulate the commercial skip lists and cut lists defined for recordings. All of the following require the additional use of --chanid and --starttime to define the recording to operate on.

--clearcutlist

Remove any currently defined cut points for the specified recording.

--clearskiplist

Remove any commercial detection results for the specified recording.

--gencutlist

Move the commercial detection results into a cut list.

Warning.png Warning: Any transcode performed at this point will permanently apply the commercial detection results without manual verification by the user. The default behavior is not to do this, as the commercial detection routines are not believed to be 100% accurate.

--getcutlist

Return the currently defined cut list as a comma-separated list of ranges. Use -q to hide unwanted logging and return only the cut list.

--getskiplist

Return the currently defined commercial detection results as a comma-separated list of ranges. Use -q to hide unwanted logging and return only the cut list.

--setcutlist

Apply a provided comma-separate list of ranges to the specified recording.

--setskiplist

Apply a provided commercial detection list of ranges to the specified recording.

File Operations

--copyfile

Copy one file or myth:// URI to another. Requires --infile and --outfile.

Messaging Access

These options are used to send popups to any available mythfrontend instance using the MythMessage interface.

--print-template

Display the default MythMessage template to use. The current default template is:

<mythmessage version="1">
  <text>%message_text%</text>
  <timeout>%timeout%</timeout>
</mythmessage>

--message

Send selected template using provided replacement text. The template will have several fields listed, that can be replaced using additional command line options of that name. In the above template, one would use --message_text and --timeout.

--bcastaddr

Select the address to send message to. The default value is 127.0.0.1 for the local host. Sending to your subnet broadcast address will display the message on any active frontend.

--udpport

Select the port to send to. The default is 6548.

MPEG-TS Information

These options are used to display stream information about MPEG recordings.

--pidcounter

Count the number of PIDs found in a recording. Requires --infile, which can be a relative or absolute file path, or a myth:// URI. Optionally accepts a --packetsize, which defaults to 188 bytes.

--pidfilter

Apply PID filter to a recording, and output the resulting MPEG video to a new file. Requires --infile and --outfile, which can be relative or absolute file paths, or myth:// URIs. Requires --pids for the filter to apply. Optionally accepts a --packetsize, which defaults to 188 bytes.

--pidprinter

Output the available PIDs found in a recording. Requires --infile, which can be a relative or absolute file path, or a myth:// URI. Requires --pids for the filter to select for. Optionally accepts --outfile, --xml, and --noautopts.

--ptspids

JobQueue Operations

--queuejob

Schedule a job of the specified type to be run through the jobqueue. Requires the use of --chanid and --starttime.