org.jmythapi.protocol.request
Interface IMythCommand

All Superinterfaces:

IVersionable

All Known Implementing Classes:

AMythCommand

public interface IMythCommand
extends IVersionable

This interface represents a MythTV-protocol command.

A MythTV-protocol command usually consists of a command-name and optionally a list of command arguments, e.g. "QUERY_REMOTEENCODER 1".
The command is send as part of a request-message to the backend server. The result of the command-processing is returned as a response-message back to the client.

Both, the request- and response-messages are transfered over network in the form of an packet.

Request/Response example:

The MythTV-request consists of a command with the name QUERY_REMOTEENCODER and an additional command parameter 1, separated by space. The additional request parameter IS_BUSY is also part of the rquest-message and is separated by []:[].
The MythTV-response consists of multiple response arguments, also separated by []:[].

33	QUERY_REMOTEENCODER 1[]:[]IS_BUSY
46	1[]:[]Tuner 1[]:[]1[]:[]1[]:[]1[]:[]0[]:[]1002

Supported Commands:

The Field Summary table listed below contains a list of commands supported by a MythTV-backend.
You can either send commands directly to a backend using a IBackendConnection, or you can use the more convenient functions provided by IBackend class. Depending on the protocol version, different commands with different command- and request-arguments and different response-arguments are supported.

Supported Protocol Versions:

All commands listed on this page are supported by at least one of the supported protocol-versions. If a given command is not supported by all known protocol-versions, it is marked with the MythProtoVersion annotation. Additionally the lower bound of the version range is documented with the @since javadoc tag, whereas the upper bound is documented with the @deprecated tag.

Which protocol versions are supported can be seen in the enumeration ProtocolVersion.

Usage Examples:

See the javadoc of the listed commands for examples, how to use the different commands.

See Also:

protocol version, protocol version range, command utils, request, response, packet, connection

Field Summary

static String	ALLOW_SHUTDOWN Allows a backend to shut down.
static String	ANN Announces a client to the backend.
static String	ANN_FILE_TRANSFER Announces a file transfer.
static String	ANN_MEDIASERVER Announces a client as mediaserver.
static String	ANN_MONITOR Announces a client as monitoring client.
static String	ANN_PLAYBACK Announces a client as playback client.
static String	ANN_RING_BUFFER Deprecated. 20
static String	ANN_SLAVEBACKEND Announces a client as slave backend.
static String	BACKEND_MESSAGE Backend Message.
static String	BACKEND_MESSAGE_ASK_RECORDING Backend Message - Ask Recording.
static String	BACKEND_MESSAGE_CLEAR_SETTINGS_CACHE Backend Message - Clear Settings Cache.
static String	BACKEND_MESSAGE_COMMFLAG_START Backend Message - Commflag Start.
static String	BACKEND_MESSAGE_DONE_RECORDING Backend Message - Done Recording.
static String	BACKEND_MESSAGE_DOWNLOAD_FILE Backend Message - Download File.
static String	BACKEND_MESSAGE_GENERATED_PIXMAP Backend Message - Pixmap generated.
static String	BACKEND_MESSAGE_LIVETV_CHAIN Backend Message - LiveTV Chain Update.
static String	BACKEND_MESSAGE_LIVETV_WATCH Backend Message - LiveTV Watch.
static String	BACKEND_MESSAGE_MASTER_UPDATE_PROG_INFO Backend Message - Master Update Program Info.
static String	BACKEND_MESSAGE_QUIT_LIVETV Backend Message - Quit LiveTV.
static String	BACKEND_MESSAGE_RECORDING_LIST_CHANGE Backend Message - Recording List Changed.
static String	BACKEND_MESSAGE_RESET_IDLETIME Backend Message - Reset Idletime.
static String	BACKEND_MESSAGE_SCHEDULE_CHANGE Backend Message - Scheduler Changed.
static String	BACKEND_MESSAGE_SHUTDOWN_COUNTDOWN Backend Message - Backend is idle and waiting for shutdown.
static String	BACKEND_MESSAGE_SHUTDOWN_NOW Backend Message - Backend will shutdown now.
static String	BACKEND_MESSAGE_SIGNAL Backend Message - Signal.
static String	BACKEND_MESSAGE_SYSTEM_EVENT Backend Message - System Event.
static String	BACKEND_MESSAGE_UPDATE_FILE_SIZE Backend Message - Recording File Size changed.
static String	BACKEND_MESSAGE_UPDATE_PROG_INFO Deprecated. 55, replaced by BACKEND_MESSAGE_RECORDING_LIST_CHANGE UPDATE.
static String	BACKEND_MESSAGE_VIDEO_LIST_CHANGE Backend Message - Video List - Change.
static String	BACKEND_MESSAGE_VIDEO_LIST_NO_CHANGE Backend Message - Video List - No Change.
static String	BLOCK_SHUTDOWN Prevents a backend shutdown.
static String	CHECK_RECORDING Check if a prgram is currently being recorded.
static String	DELETE_FAILED_RECORDING Deprecated. 39, only available for a very short time.
static String	DELETE_FILE Delete a remote file.
static String	DELETE_RECORDING Marks a recording for deletion.
static String	DONE Closes a backend connection.
static String	DOWNLOAD_FILE Downloads a file on the backend.
static String	DOWNLOAD_FILE_NOW Downloads a file on the backend immediately.
static String	FILL_PROGRAM_INFO Updates the pathname and file-size of a recording.
static String	FORCE_DELETE_RECORDING Forces deleting of a recording.
static String	FORGET_RECORDING Forgets a recording.
static String	FREE_TUNER Releases a locked tuner.
static String	GET_FREE_RECORDER Gets the next free recorder.
static String	GET_FREE_RECORDER_COUNT Gets the amount of free recorders.
static String	GET_FREE_RECORDER_LIST Gets all free recorders.
static String	GET_NEXT_FREE_RECORDER Gets the next free recorder.
static String	GET_RECORDER_FROM_NUM Gets a recorder by ID.
static String	GET_RECORDER_NUM Queries the recorder that is recording a given program.
static String	GO_TO_SLEEP Put to sleep a backend.
static String	LOCK_TUNER Locks a tuner.
static String	MESSAGE Message.
static String	MYTH_PROTO_VERSION Negotiates the protocol version to use.
static String	OK OK.
static String	QUERY_ACTIVE_BACKENDS Queries the names of all active backends.
static String	QUERY_BOOKMARK Queries bookmarks.
static String	QUERY_CHECKFILE Checks if a file exists.
static String	QUERY_COMMBREAK Queries commerical breaks.
static String	QUERY_CUTLIST Queries cutlists.
static String	QUERY_FILE_EXISTS Check the existence of a remote file.
static String	QUERY_FILE_HASH Query a file hash value.
static String	QUERY_FILETRANSFER Filetransfer queries.
static String	QUERY_FILETRANSFER_DONE Filetransfer - Finish file-transfer.
static String	QUERY_FILETRANSFER_IS_OPEN Filetransfer - Checks if a file is open.
static String	QUERY_FILETRANSFER_REOPEN Filetransfer - Reopen a file.
static String	QUERY_FILETRANSFER_REQUEST_BLOCK Filetransfer - Request a file block.
static String	QUERY_FILETRANSFER_SEEK Filetransfer - Seek within a file.
static String	QUERY_FILETRANSFER_SET_TIMEOUT Filetransfer - Configure timeout.
static String	QUERY_FILETRANSFER_WRITE_BLOCK Filetransfer - Write a file block.
static String	QUERY_FREE_SPACE Returns the free space on the connected backend.
static String	QUERY_FREE_SPACE_LIST Returns the free space of all backends.
static String	QUERY_FREE_SPACE_SUMMARY Queries the free space on all backends.
static String	QUERY_FREESPACE Deprecated. 17, use QUERY_FREE_SPACE instead
static String	QUERY_GENPIXMAP Deprecated. 61, replaced by QUERY_GENPIXMAP2
static String	QUERY_GENPIXMAP2 Generates a preview image of an recording.
static String	QUERY_GETALLPENDING Queries all pending recordings.
static String	QUERY_GETALLSCHEDULED Queries all scheduled recordings.
static String	QUERY_GETCONFLICTING Queries all conflicting recordings.
static String	QUERY_GETEXPIRING Queries all expiring recordings.
static String	QUERY_GUIDEDATATHROUGH Queries tv-guide data status.
static String	QUERY_HOSTNAME Query hostname.
static String	QUERY_IS_ACTIVE_BACKEND Checks if a backend is active.
static String	QUERY_ISRECORDING Queries if a backend is recording.
static String	QUERY_LOAD Queries the system load.
static String	QUERY_MEMSTATS Queries the memory usage.
static String	QUERY_PIXMAP_GET_IF_MODIFIED Queries a preview image.
static String	QUERY_PIXMAP_LASTMODIFIED Queries the last-modified date of a preview image.
static String	QUERY_RECORDER Queries a recorder.
static String	QUERY_RECORDER_CANCEL_NEXT_RECORDING Cancel next recording.
static String	QUERY_RECORDER_CHANGE_BRIGHTNESS Changes brightness.
static String	QUERY_RECORDER_CHANGE_CHANNEL Change channel.
static String	QUERY_RECORDER_CHANGE_COLOUR Change colour.
static String	QUERY_RECORDER_CHANGE_CONTRAST Changes contrast.
static String	QUERY_RECORDER_CHANGE_HUE Changes hue.
static String	QUERY_RECORDER_CHECK_CHANNEL Check if channel exists on current.
static String	QUERY_RECORDER_CHECK_CHANNEL_PREFIX Check channel prefix.
static String	QUERY_RECORDER_DONE_RINGBUF Deprecated. 20
static String	QUERY_RECORDER_FILL_DURATION_MAP Queries the duration map of a recording.
static String	QUERY_RECORDER_FILL_POSITION_MAP Queries keyframe position map.
static String	QUERY_RECORDER_FINISH_RECORDING Finish recording.
static String	QUERY_RECORDER_FRONTEND_READY Frontend ready.
static String	QUERY_RECORDER_GET_BRIGHTNESS Get Brightness.
static String	QUERY_RECORDER_GET_CHANNEL_INFO Query channel info.
static String	QUERY_RECORDER_GET_COLOUR Get colour.
static String	QUERY_RECORDER_GET_CONNECTED_INPUTS Deprecated. 37, replaced by QUERY_RECORDER_GET_FREE_INPUTS
static String	QUERY_RECORDER_GET_CONTRAST Get contrast.
static String	QUERY_RECORDER_GET_CURRENT_RECORDING Queries current recording.
static String	QUERY_RECORDER_GET_FILE_POSITION Queries written bytes.
static String	QUERY_RECORDER_GET_FRAMERATE Queries frame rate.
static String	QUERY_RECORDER_GET_FRAMES_WRITTEN Queries written frames.
static String	QUERY_RECORDER_GET_FREE_INPUTS Get free inputs.
static String	QUERY_RECORDER_GET_FREE_SPACE Deprecated. 20
static String	QUERY_RECORDER_GET_HUE Get hue.
static String	QUERY_RECORDER_GET_INPUT Query used input.
static String	QUERY_RECORDER_GET_INPUT_NAME Deprecated. 21, use QUERY_RECORDER_GET_INPUT instead.
static String	QUERY_RECORDER_GET_KEYFRAME_POS Queries keyframe position.
static String	QUERY_RECORDER_GET_MAX_BITRATE Queries maximum bitrage.
static String	QUERY_RECORDER_GET_NEXT_PROGRAM_INFO Query program info.
static String	QUERY_RECORDER_GET_PROGRAM_INFO Deprecated. 21, use QUERY_RECORDER_GET_RECORDING or QUERY_RECORDER_GET_NEXT_PROGRAM_INFO instead.
static String	QUERY_RECORDER_GET_RECORDING Query current recording.
static String	QUERY_RECORDER_IS_RECORDING Query busy status.
static String	QUERY_RECORDER_PAUSE Pause recorder.
static String	QUERY_RECORDER_PAUSE_RECORDER Deprecated. 18, was supported just a very short time period, use QUERY_RECORDER_PAUSE instead.
static String	QUERY_RECORDER_REQUEST_BLOCK_RINGBUF Deprecated. 20
static String	QUERY_RECORDER_SEEK_RINGBUF Deprecated. 20
static String	QUERY_RECORDER_SET_CHANNEL Set Channel.
static String	QUERY_RECORDER_SET_INPUT Change input.
static String	QUERY_RECORDER_SET_LIVE_RECORDING Keep LiveTV recording.
static String	QUERY_RECORDER_SET_SIGNAL_MONITORING_RATE Sets the signal monitoring rate.
static String	QUERY_RECORDER_SETUP_RING_BUFFER Deprecated. 20
static String	QUERY_RECORDER_SHOULD_SWITCH_CARD Check if channel exists on other recorder.
static String	QUERY_RECORDER_SPAWN_LIVETV Spawn LiveTV.
static String	QUERY_RECORDER_STOP_LIVETV Stop LiveTV.
static String	QUERY_RECORDER_STOP_PLAYING Deprecated. 20
static String	QUERY_RECORDER_TOGGLE_CHANNEL_FAVORITE Toggle channel favorite.
static String	QUERY_RECORDER_TOGGLE_INPUTS Deprecated. 27, replaced by QUERY_RECORDER_GET_CONNECTED_INPUTS, QUERY_RECORDER_GET_INPUT and QUERY_RECORDER_SET_INPUT
static String	QUERY_RECORDER_UNPAUSE Deprecated. 18, was supported just a very short time period
static String	QUERY_RECORDING Queries a single recording.
static String	QUERY_RECORDING_BASENAME Queries a single recording by basename.
static String	QUERY_RECORDING_TIMESLOT Queries a single recording by channel-id and recording-start-time.
static String	QUERY_RECORDINGS Queries all recorded programs.
static String	QUERY_REMOTEENCODER Queries a remote encoder.
static String	QUERY_REMOTEENCODER_CANCEL_NEXT_RECORDING Cancel the next recording.
static String	QUERY_REMOTEENCODER_GET_CURRENT_RECORDING Queries current recording.
static String	QUERY_REMOTEENCODER_GET_FLAGS Queries the remote encoder flags.
static String	QUERY_REMOTEENCODER_GET_FREE_INPUTS Query connected inputs.
static String	QUERY_REMOTEENCODER_GET_MAX_BITRATE Get maximum bitrate.
static String	QUERY_REMOTEENCODER_GET_RECORDING_STATUS Query encoder status.
static String	QUERY_REMOTEENCODER_GET_SLEEPSTATUS Queries sleep status.
static String	QUERY_REMOTEENCODER_GET_STATE Queries the state of the remote encoder.
static String	QUERY_REMOTEENCODER_IS_BUSY Query the remote-encoder busy status.
static String	QUERY_REMOTEENCODER_MATCHES_RECORDING Checks if a remote encoder is recording the given program.
static String	QUERY_REMOTEENCODER_RECORD_PENDING Start recording of a pending program.
static String	QUERY_REMOTEENCODER_START_RECORDING Start recording of a program.
static String	QUERY_REMOTEENCODER_STOP_RECORDING Stop recording.
static String	QUERY_SETTING Queries backend settings.
static String	QUERY_SG_FILEQUERY Query storage group file.
static String	QUERY_SG_GETFILELIST Query storage group.
static String	QUERY_TIME_ZONE Queries the timezone of a backend.
static String	QUERY_UPTIME Queries the uptime.
static String	QUEUE_TRANSCODE Deprecated. 23
static String	QUEUE_TRANSCODE_CUTLIST Deprecated. 23
static String	QUEUE_TRANSCODE_STOP Deprecated. 23
static String	REACTIVATE_RECORDING Deprecated. 19
static String	REFRESH_BACKEND Reloading backend settings.
static String	RESCHEDULE_RECORDINGS Reschedules recordings.
static String	SCAN_VIDEOS Scan video folder.
static String	SET_BOOKMARK Setting bookmarks.
static String	SET_CHANNEL_INFO Changes channel infos.
static String	SET_NEXT_LIVETV_DIR Changes LiveTV recording directory.
static String	SET_SETTING Configure backend settings.
static String	SHUTDOWN_NOW Shutdown a slave backend.
static String	STOP_RECORDING Stop a currently active recording.
static String	UNDELETE_RECORDING Undelete a recording.
static String	UNKNOWN_COMMAND Unknown Command.

Method Summary

String	getCommandArgument(int idx) Returns the command argument at the given position.
List<String>	getCommandArguments() Gets the arguments of this command.
int	getCommandArgumentsLength() Gets the amount of available command arguments
String	getName() Gets the name of this command.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Field Detail

MYTH_PROTO_VERSION

static final String MYTH_PROTO_VERSION

Negotiates the protocol version to use.

This command must be sent afer a backend connection was established, to check if the client and backend are speeking the same protocol version.

MythTV protocol example:
An accepted protocol version:
21	MYTH_PROTO_VERSION 15
13	ACCEPT[]:[]15
A rejected protocol version:
30	MYTH_PROTO_VERSION 70 53153836
13	REJECT[]:[]63

Command parameters:

1. protocol version of the client

Request parameters:

none

Response arguments:

1. string
   ACCEPT | REJECT
2. int
   protocol version of the server

Since:

01

See Also:

IBackendConnection.open(), Wiki, Constant Field Values

MythTV protocol range: [01,-1)

	Version	Date	Additional Version Info
Added	01	2004-01-29	Changelog, SVN-Rev.: 3021
Removed	-1

ANN

static final String ANN

Announces a client to the backend.

This type of command registers as client to the backend and announces a new connection of the given type.

The following connection types are available:

• ANN_PLAYBACK: for blocking playback connections
• ANN_MONITOR: for non blocking monitor connections (Since 22)
• ANN_FILE_TRANSFER: for file transfer connections
• ANN_RING_BUFFER: for ring-buffer connections (Removed in 20)
• ANN_SLAVEBACKEND: used by slave backends
• ANN_MEDIASERVER: used by a mediaserver accessing the backend (Since 68)

MythTV protocol example:
Announce a playback connection:
25	ANN Playback MythClient 0
2	OK
Announce a monitoring connection:
24	ANN Monitor MythClient 0
2	OK
Announce a file transfer:
64	ANN FileTransfer mythtv 0 -1[]:[]/channels/atv_at.jpg[]:[]Default
24	OK[]:[]31[]:[]0[]:[]5752

Since:

00

See Also:

ANN_PLAYBACK, ANN_MONITOR, ANN_FILE_TRANSFER, ANN_SLAVEBACKEND, ANN_RING_BUFFER, ANN_MEDIASERVER, IBackend.annotatePlayback(...), IBackend.annotateMonitor(...), IBackend.annotateFileTransfer(...), IBackend.annotateRingBuffer(...), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	20	2005-11-05	Changelog, SVN-Rev.: 7739
Changed	22	2005-11-15	Changelog, SVN-Rev.: 7883
Changed	68	2011-07-09	Changelog
Removed	-1

DONE

static final String DONE

Closes a backend connection.

This commands signals the backend that the client will release the connection.

MythTV protocol example:
4	DONE

Command parameters:

none

Request parameters:

none

Response parameters:

none

Since:

00

See Also:

IBackendConnection.close(), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDINGS

static final String QUERY_RECORDINGS

Queries all recorded programs.

This command is used to query a list of recordings in the system.

MythTV protocol example:
21	QUERY_RECORDINGS Play
847	2[]:[]Lara Croft: Tomb Raider - Die Wiege des Lebens[]:[][]:[][]:[]Actionthriller[]:[]17[]:[]1[]:[]ORF1[]:[]ORF 1[]:[]myth://127.0.0.1:6543/17_20051223201000_20051223221000.nuv[]:[]1[]:[]336893888[]:[]1135365000[]:[]1135372200[]:[][]:[]0[]:[]0[]:[]mythtv[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]1135365000[]:[]1135372200[]:[]0[]:[]21[]:[]Default[]:[]0[]:[][]:[]196631507[]:[][]:[]1135516681[]:[]0.000000[]:[]1135292400[]:[]1[]:[]Vanilla Sky[]:[][]:[][]:[]Psychothriller[]:[]17[]:[]1[]:[]ORF1[]:[]ORF 1[]:[]myth://127.0.0.1:6543/17_20051227012500_20051227034500.nuv[]:[]1[]:[]1108228032[]:[]1135643100[]:[]1135651500[]:[][]:[]0[]:[]0[]:[]mythtv[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]1135643100[]:[]1135651500[]:[]0[]:[]5[]:[]Default[]:[]0[]:[][]:[]58711337[]:[][]:[]1135660161[]:[]0.000000[]:[]1135638000[]:[]1

Command parameters:

1. String
   RecoringsType - Play, Delete, Recording (see here for all constants)
   Since 33

Request parameters:

none

Response arguments:

1. int
   number of recordings
2. progInfo[]
   a list of recordings (see here for all properties)

Since:

00

See Also:

IBackend.queryRecordings(), IBackend.queryRecordings(org.jmythapi.protocol.request.ERecordingsType), IProgramInfoList, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	33	2007-03-01	Changelog, SVN-Rev.: 12904
Removed	-1

QUERY_RECORDING

static final String QUERY_RECORDING

Queries a single recording.

This command is used to query single recording based on its channel-id and recording-starting-time or its basename.
See here for all possible variants.

MythTV protocol example:
With timeslot:
49	QUERY_RECORDING TIMESLOT 1057 2010-08-11T13:37:47
443	OK[]:[]Tom auf heißer Spur[]:[]Der Kinderzimmer-Kobold[]:[][]:[][]:[]1057[]:[]1[]:[]ORF 1[]:[]ORF 1[]:[]1057_20100811133747.mpg[]:[]0[]:[]88213944[]:[]1281525300[]:[]1281526800[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1281526667[]:[]1281526800[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]257651874[]:[][]:[]1281526803[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]1[]:[]2[]:[]0[]:[]
With basename:
48	QUERY_RECORDING BASENAME 1057_20100811133747.mpg
443	OK[]:[]Tom auf heißer Spur[]:[]Der Kinderzimmer-Kobold[]:[][]:[][]:[]1057[]:[]1[]:[]ORF 1[]:[]ORF 1[]:[]1057_20100811133747.mpg[]:[]0[]:[]88213944[]:[]1281525300[]:[]1281526800[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1281526667[]:[]1281526800[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]257651874[]:[][]:[]1281526803[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]1[]:[]2[]:[]0[]:[]
On error:
48	QUERY_RECORDING BASENAME 1057_20100811133747.XYZ
5	ERROR

Command variants:

The following varians of this command are possible:

• Query recording by basename: QUERY_RECORDING_BASENAME
• Query recording by timeslot: QUERY_RECORDING_TIMESLOT

Since:

32

See Also:

IBackend.queryRecording(String), IBackend.queryRecording(Integer, java.util.Date), Wiki, Constant Field Values

MythTV protocol range: [32,-1)

	Version	Date	Additional Version Info
Added	32	2006-11-30	Changelog, SVN-Rev.: 12151
Removed	-1

QUERY_FREE_SPACE

static final String QUERY_FREE_SPACE

Returns the free space on the connected backend.

This command is similar to QUERY_FREE_SPACE_LIST, except that it only returns the free space for the connected host. Other slave backends are not taken into account.

This is a replacement for QUERY_FREESPACE.

MythTV protocol example:
16	QUERY_FREE_SPACE
320	mythbox[]:[]/mnt/VHS/mythpinky[]:[]0[]:[]-1[]:[]12[]:[]524288[]:[]0[]:[]-449278464[]:[]0[]:[]-925365248[]:[] mythbox[]:[]/var/lib/mythtv/livetv[]:[]1[]:[]-1[]:[]11[]:[]4096[]:[]0[]:[]144629480[]:[]0[]:[]29703436[]:[] mythbox[]:[]/var/lib/mythtv/recordings[]:[]1[]:[]-1[]:[]1[]:[]4096[]:[]0[]:[]144629480[]:[]0[]:[]29703436

Command parameters:

none

Request parameters:

none

Response parameters:

A list of:

1. string
   hostname
2. string
   directories
3. boolean
   is_local
4. int
   filesystem id
5. int
   storage group id
6. int
   block size id
7. int,int
   total space in bytes
   deprecated 66
8. long
   total space in bytes
   since 66
9. int,int
   used space in bytes
   deprecated 66
10. long
    used space in bytes
    since 66

Since:

17

See Also:

IBackend.queryFreeSpaceList(boolean), IFreeSpaceList, Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_FREE_SPACE_LIST

static final String QUERY_FREE_SPACE_LIST

Returns the free space of all backends.

When this command is called on the master backend, it returns every backend's disk space stats, prepended with the hostname of each.

This is a replacement for QUERY_FREESPACE.

MythTV protocol example:
21	QUERY_FREE_SPACE_LIST
236	mythbox[]:[]mythbox:/var/lib/mythtv/livetv,mythbox:/var/lib/mythtv/recordings[]:[]1[]:[]1[]:[]10[]:[]4096[]:[]0[]:[]18761596[]:[]0[]:[]2985540[]:[] mythbox[]:[]TotalDiskSpace[]:[]0[]:[]-2[]:[]-2[]:[]0[]:[]0[]:[]18761596[]:[]0[]:[]2985540

Command parameters:

none

Request parameters:

none

Response parameters:

A list of:

1. string
   hostname
2. string
   directories
3. boolean
   is_local
4. int
   filesystem id
5. int
   storage group id
6. int
   block size id
7. int,int
   total space in bytes
   deprecated 66
8. long
   total space in bytes
   since 66
9. int,int
   used space in bytes
   deprecated 66
10. long
    used space in bytes
    since 66

The last entry of the list has the directory name TotalDiskSpace and is a summary of all other entries.

Since:

17

See Also:

IBackend.queryFreeSpaceList(boolean), IFreeSpaceList, Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_FREESPACE

static final String QUERY_FREESPACE

Deprecated. 17, use QUERY_FREE_SPACE instead

Returns the free space on the connected backend.

MythTV protocol example:
15	QUERY_FREESPACE
14	30534[]:[]9630

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   totalspace im MB
2. int
   usedspace in MB

Since:

00

See Also:

IBackend.queryFreeSpace(), IFreeSpace, Constant Field Values

MythTV protocol range: [00,17)

	Version	Date	Additional Version Info
Added	00
Removed	17	2005-05-24	Changelog, SVN-Rev.: 6482

QUERY_FREE_SPACE_SUMMARY

static final String QUERY_FREE_SPACE_SUMMARY

Queries the free space on all backends.

This command summarizes the free space on all backends.

MythTV protocol example:
24	QUERY_FREE_SPACE_SUMMARY
32	0[]:[]18761596[]:[]0[]:[]2985552

Command parameters:

none

Request parameters:

none

Response parameters:

1. int,int
   total space in MB
   deprecated 66
2. long
   total space in MB
   since 66
3. int,int
   used space in MB
   deprecated 66
4. long
   used space in MB
   since 66

Since:

32

See Also:

IBackend.queryFreeSpaceSummary(), IFreeSpaceSummary, Wiki, Constant Field Values

MythTV protocol range: [32,-1)

	Version	Date	Additional Version Info
Added	32	2006-11-30	Changelog, SVN-Rev.: 12151
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_LOAD

static final String QUERY_LOAD

Queries the system load.

This command queries the system load on the backend.

MythTV protocol example:
10	QUERY_LOAD
22	0.04[]:[]0.03[]:[]0.08

Command parameters:

none

Request parameters:

none

Response parameters:

1. double
   current load
2. double
   average load last 5 mins
3. double
   average load last 15 mins

Since:

15

See Also:

IBackend.queryLoad(), ILoad, Wiki, Constant Field Values

MythTV protocol range: [15,-1)

	Version	Date	Additional Version Info
Added	15	2005-03-23	Changelog, MythTV-Release: 0.18, SVN-Rev.: 5833
Removed	-1

QUERY_UPTIME

static final String QUERY_UPTIME

Queries the uptime.

This command queries the uptime of the backend and returns the number of seconds the backend's host has been running.

MythTV protocol example:
12	QUERY_UPTIME
4	3251

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   uptime in seconds

Since:

15

See Also:

IBackend.queryUptime(), IUptime, Wiki, Constant Field Values

MythTV protocol range: [15,-1)

	Version	Date	Additional Version Info
Added	15	2005-03-23	Changelog, MythTV-Release: 0.18, SVN-Rev.: 5833
Removed	-1

QUERY_MEMSTATS

static final String QUERY_MEMSTATS

Queries the memory usage.

This command queries the memory usage of the backend.

MythTV protocol example:
14	QUERY_MEMSTATS
26	121[]:[]11[]:[]917[]:[]917

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   total RAM MB
2. int
   free RAM MB
3. int
   total VM MB
4. int
   free VM MB

Since:

15

See Also:

IBackend.queryMemStats(), IMemStats, Constant Field Values

MythTV protocol range: [15,-1)

	Version	Date	Additional Version Info
Added	15	2005-03-23	Changelog, MythTV-Release: 0.18, SVN-Rev.: 5833
Removed	-1

QUERY_CHECKFILE

static final String QUERY_CHECKFILE

Checks if a file exists.

This command asks the backend to check the file information on the program.

The checkslaves parameter should be 1 to request that the query should be passed on to the slave backend (given by the hostname field in the ProgramInfo) and return a URI or 0 to ignore this field and check only on the local machine returning a file path.
Apart from the hostname as described above, as of version 0.22 only the chanid and recstartts fields of the specified ProgramInfo record can be used to determine the program to be checked. The command can thus be used as a mapping between chanid + recstartts and the path to the recording. In this case the path-name must be set to null.
See ProgramInfo::GetRecordBasename(bool fromDB) for details.

MythTV protocol example:
Protocol version 32:
545	QUERY_CHECKFILE[]:[]1[]:[]Germany's next Topmodel[]:[][]:[]Wer wird Deutschlands nächstes Supermodel? mit Thomas Rath, Thomas Hayo[]:[]show/gameshow[]:[]1063[]:[]1[]:[]PRO7[]:[]Pro7[]:[]/var/lib/mythtv/livetv/1063_20110410104434.mpg[]:[]0[]:[]0[]:[]1302419100[]:[]1302426600[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1302425074[]:[]1302426600[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]181080940[]:[][]:[]1302419100[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]2011
52	1[]:[]/var/lib/mythtv/livetv/1063_20110410104434.mpg
Protocol version 15:
463	QUERY_CHECKFILE[]:[]Die Simpsons[]:[][]:[]Das geheime Bekenntnis Zeichentrick[]:[]Kinderprogramm[]:[]1000[]:[]1[]:[]PRO7[]:[]Pro7[]:[]myth://knoppmyth:6543/1000_20110804183000_20110804184000.nuv[]:[]0[]:[]110700582[]:[]1312475400[]:[]1312476000[]:[][]:[]0[]:[]0[]:[]knoppmyth[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]0[]:[]0[]:[]0[]:[]0[]:[]1312475400[]:[]1312476000[]:[]0[]:[]4[]:[]Default[]:[]0[]:[][]:[]216592835[]:[][]:[]1312475596[]:[]0.000000[]:[]1312408800[]:[]1
1	1
Protocol version 32: If the file is not available:
374	QUERY_CHECKFILE[]:[]1[]:[]Tagesschau[]:[][]:[][]:[]nachrichten[]:[]1002[]:[]4[]:[]ARD[]:[]ARD[]:[][]:[]0[]:[]1326096001[]:[]1326096181[]:[]0[]:[]mythbuntu11[]:[]1[]:[]3[]:[]2[]:[]1[]:[]-1[]:[]15[]:[]1[]:[]15[]:[]6[]:[]1326096001[]:[]1326096181[]:[]0[]:[]Default[]:[][]:[]212613461[]:[][]:[]1326094992[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]2[]:[]0[]:[]2012
6	0[]:[]

Command parameters:

none

Request parameters:

1. bool
   checkslaves - 1=true, 0=false
   since 32
2. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   1=exists, 0=not found
2. string
   filename
   since 32

Since:

00

See Also:

Wiki, IBackend.queryCheckFile(IProgramInfo, Boolean), IFileStatus, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	32	2006-11-30	Changelog, SVN-Rev.: 12151
Removed	-1

QUERY_GUIDEDATATHROUGH

static final String QUERY_GUIDEDATATHROUGH

Queries tv-guide data status.

This command asks the backend for the date and time the guide data is filled through.

MythTV protocol example:
22	QUERY_GUIDEDATATHROUGH
16	2007-01-26 18:30

Command parameters:

none

Request parameters:

none

Response parameters:

1. date
   program guide date

Since:

15

See Also:

IBackend.queryGuideDataThrough(), IGuideDataThrough, Wiki, Constant Field Values

MythTV protocol range: [15,-1)

	Version	Date	Additional Version Info
Added	15	2005-03-23	Changelog, MythTV-Release: 0.18, SVN-Rev.: 5833
Removed	-1

QUEUE_TRANSCODE

static final String QUEUE_TRANSCODE

Deprecated. 23

Enqueues a recording for transcoding.

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   0

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,23)

	Version	Date	Additional Version Info
Added	00
Removed	23	2006-01-10	Changelog, SVN-Rev.: 8553

QUEUE_TRANSCODE_STOP

static final String QUEUE_TRANSCODE_STOP

Deprecated. 23

Stops transcoding of a recording.

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   0

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,23)

	Version	Date	Additional Version Info
Added	00
Removed	23	2006-01-10	Changelog, SVN-Rev.: 8553

QUEUE_TRANSCODE_CUTLIST

static final String QUEUE_TRANSCODE_CUTLIST

Deprecated. 23

Enqueues a recording for transcoding and cutlist processing.

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   0

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,23)

	Version	Date	Additional Version Info
Added	00
Removed	23	2006-01-10	Changelog, SVN-Rev.: 8553

STOP_RECORDING

static final String STOP_RECORDING

Stop a currently active recording.

MythTV protocol example:
959	STOP_RECORDING[]:[]Fringe - Grenzfälle des FBI[]:[]Kontrolle[]:[]Der Sohn eines hochrangigen Massive Dynamic-Mitarbeiters wird entführt. Bei der Flucht sterben mehrere Polizisten auf merkwürdige Weise, nämlich durch die Waffe einer Kollegin, die sich auch selbst erschießt. Es scheint, als habe es die Fringe-Abteilung mit einer Art Bewusstseinskontrolle zu tun. Bei der übergabe der geforderten 2 Millionen Dollar kommt schließlich heraus, dass der eigentliche Entführer der 15-jährige Tyler selbst ist, der jetzt Peter in seiner Gewalt hat ...[]:[][]:[]11123[]:[]10123[]:[]PULS 4[]:[]PULS 4[]:[]/var/lib/mythtv/recordings/11123_20110401233600.mpg[]:[]0[]:[]0[]:[]1301691898[]:[]1301695104[]:[]0[]:[]0[]:[]0[]:[]brain[]:[]1[]:[]1[]:[]1[]:[]1[]:[]-2[]:[]330[]:[]1[]:[]15[]:[]6[]:[]1301693760[]:[]1301695104[]:[]0[]:[]0[]:[]Default[]:[]0[]:[][]:[][]:[][]:[]1301693739[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]0[]:[]0[]:[]0
1	1
If the recording could not be stopped (Protocol Version 15):
421	STOP_RECORDING[]:[]Die Nanny[]:[][]:[][]:[]Serie[]:[]1015[]:[]14[]:[]SUPRT[]:[]Super RTL[]:[]myth://127.0.0.1:6543/1015_20110414231000_20110414231000.nuv[]:[]0[]:[]25010112[]:[]1302822600[]:[]1302822600[]:[][]:[]0[]:[]0[]:[]knoppmyth[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]2[]:[]0[]:[]15[]:[]6[]:[]1302822600[]:[]1302822600[]:[]0[]:[]5[]:[]Default[]:[]0[]:[][]:[]122965929[]:[][]:[]1302822682[]:[]0.000000[]:[]1302739200[]:[]1
2	-1

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   recorder-id (-1 if no recorder is recording the program)

Since:

00

See Also:

IBackend.stopRecording(IProgramInfo), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

CHECK_RECORDING

static final String CHECK_RECORDING

Check if a prgram is currently being recorded.

This command checks if a program is currently being recorded and return the number of the recorder or 0, if it is not being recorded.

MythTV protocol example:
423	CHECK_RECORDING[]:[]Unknown[]:[][]:[][]:[][]:[]1001[]:[]1[]:[]VOX[]:[]VOX[]:[]/var/lib/mythtv/livetv/1001_20100622062602.mpg[]:[]0[]:[]0[]:[]1277180761[]:[]1277181000[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1277180762[]:[]1277181000[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[][]:[][]:[]1277180761[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]
1	1
If recording is not in progress:
368	CHECK_RECORDING[]:[]Tagesschau[]:[][]:[][]:[]nachrichten[]:[]1002[]:[]4[]:[]ARD[]:[]ARD[]:[][]:[]0[]:[]1326096001[]:[]1326096181[]:[]0[]:[]mythbuntu11[]:[]1[]:[]3[]:[]2[]:[]1[]:[]-1[]:[]15[]:[]1[]:[]15[]:[]6[]:[]1326096001[]:[]1326096181[]:[]0[]:[]Default[]:[][]:[]212613461[]:[][]:[]1326095104[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]2[]:[]0[]:[]2012
1	0

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   card-id (0 if no recorder was found)

Since:

00

See Also:

Wiki, IBackend.checkRecording(IProgramInfo), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

DELETE_RECORDING

static final String DELETE_RECORDING

Marks a recording for deletion.

This command marks a file on the backend for deletion, following the existing deletion rules.
If the property AutoExpireInsteadOfDelete is set to false, the recording will be deleted immediatelly.

There are two variants of this command:

• Delete recording by programInfo (link)
• Delete recording by channel-id and recording-start-time (link, since 41)

If the recording is deleted by programInfo, or if FORCE is not set, this command only deletes the recording but not its metadata.
See FORCE_DELETE_RECORDING if the recording metadata should be deleted too, or use the additional parameter FORCE.

If the recording is deleted by programInfo, or if FORGET is not set, this command only deletes the recording but not the recording history.
See FORGET_RECORDING if the history of a recording should be deleted, or use the additional parameter FORGET.

MythTV protocol example:
Delete by programInfo - File deleted:
975	DELETE_RECORDING[]:[]Pink! österreichs Starmagazin[]:[]Thema u.a.: Germany's next Topmodel[]:[]"Pink! österreichs Starmagazin" zeigt die VIPs in österreich und dem Rest der Welt, so wie sie wirklich sind: manchmal glänzend, manchmal ungeschminkt, aber immer hautnah! Von Montag bis Freitag wird die schillernde Welt der Stars, Promis und Adabeis genauer beleuchtet. Dazu kommen noch die aktuellsten Trends aus den Gebieten Fashion, Lifestyle und Styling! Dabei ist "Pink!" alles: informativ, witzig, aktuell und kritisch. Nur eines ist "Pink!" nicht: todernst![]:[][]:[]11123[]:[]10123[]:[]PULS 4[]:[]PULS 4[]:[]myth://192.168.10.201:6543/11123_20110402000000.mpg[]:[]0[]:[]5213428[]:[]1301695104[]:[]1301696824[]:[]0[]:[]0[]:[]0[]:[]brain[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]332[]:[]0[]:[]15[]:[]6[]:[]1301695200[]:[]1301695200[]:[]0[]:[]4[]:[]Default[]:[]0[]:[][]:[][]:[][]:[]1301695225[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]0[]:[]0[]:[]0
2	-1
Delete by programInfo - File not found:
369	DELETE_RECORDING[]:[]Tagesschau[]:[][]:[][]:[]nachrichten[]:[]1002[]:[]4[]:[]ARD[]:[]ARD[]:[][]:[]0[]:[]1326096001[]:[]1326096181[]:[]0[]:[]mythbuntu11[]:[]1[]:[]3[]:[]2[]:[]1[]:[]-1[]:[]15[]:[]1[]:[]15[]:[]6[]:[]1326096001[]:[]1326096181[]:[]0[]:[]Default[]:[][]:[]212613461[]:[][]:[]1326095104[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]2[]:[]0[]:[]2012
2	-2
Delete by channel-id and recording-start-time - File deleted:
54	DELETE_RECORDING 1010 2012-01-10T15:43:00 FORCE FORGET
2	-1

Delete by ProgramInfo

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   -1=file deleted, -2=file not found, if the recording is in progress the recorder ID is returned.

Delete by channel-id and recording-start-time (since 41):

Command parameters:

1. string
   FORCE | NO_FORCE (optional)
   since 56
2. string
   FORGET | NO_FORGET (optional)
   since 59

Request parameters:

1. int
   channel id
2. date
   recording start time

Response parameters:

1. int
   -1=file deleted, -2=file not found, if the recording is in progress the recorder ID is returned.

Since:

00

See Also:

FORGET_RECORDING, FORCE_DELETE_RECORDING, IBackend.deleteRecording(IProgramInfo), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	41	2008-09-25	Changelog, SVN-Rev.: 18419
Changed	56	2009-12-29	Changelog, Changelog, MythBuntu-Release: 10.04, MythTV-Release: 0.23, SVN-Rev.: 23028, SVN-Rev.: 23012
Changed	59	2010-08-26	Changelog, SVN-Rev.: 25858
Removed	-1

DELETE_FAILED_RECORDING

static final String DELETE_FAILED_RECORDING

Deprecated. 39, only available for a very short time.

Deletes a failed recording.

This command was only available in 38, therefore we will not implement it.

Since:

38

See Also:

Constant Field Values

MythTV protocol range: [38,39)

	Version	Date	Additional Version Info
Added	38	2008-01-23	Changelog, SVN-Rev.: 15550
Removed	39	2008-01-31	Changelog, MythTV-Release: 0.21, SVN-Rev.: 15701

FORCE_DELETE_RECORDING

static final String FORCE_DELETE_RECORDING

Forces deleting of a recording.

This command forces the backend to delete a recording and its metadata.
See DELETE_RECORDING if only the recording but not its metadata should be deleted.

MythTV protocol example:
445	FORCE_DELETE_RECORDING[]:[]Eine Frage der Ehe[]:[]Til Death[]:[][]:[]comedy[]:[]1010[]:[]6[]:[]ORF1[]:[]ORF1[]:[]myth://192.168.10.207:6543/1010_20120109115200.mpg[]:[]458432000[]:[]1326105301[]:[]1326106801[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]24[]:[]0[]:[]0[]:[]0[]:[]1326106320[]:[]1326106800[]:[]5[]:[]Default[]:[][]:[]58973125[]:[][]:[]1326107293[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]2[]:[]0[]:[]2006
2	-1

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   -1=file deleted, -2=file not found, or recorder-id if the recording is in progress the recorder ID is returned.

Since:

16

See Also:

IBackend.forceDeleteRecording(IProgramInfo), Constant Field Values

MythTV protocol range: [16,-1)

	Version	Date	Additional Version Info
Added	16	2005-05-03	Changelog, SVN-Rev.: 6284
Removed	-1

REACTIVATE_RECORDING

static final String REACTIVATE_RECORDING

Deprecated. 19

Reactivates a inactive recording.

This command allows inactive recordings to be reactivated.

This can be used fro things like restarting a program that was stopped or deleted in progress or starting a program after correcting a low disk space or tuner busy condition.

Starting with protocol version 19, a recording can be only reactivated by setting the reactivate property in database table oldrecorded.

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. boolean
   1=success, 0=failed

Since:

05

See Also:

IBackend.reactivateRecording(org.jmythapi.protocol.response.IProgramInfo), Constant Field Values

MythTV protocol range: [05,19)

	Version	Date	Additional Version Info
Added	05	2004-04-10	Changelog, SVN-Rev.: 3503
Removed	19	2005-10-09	Changelog, SVN-Rev.: 7427

UNDELETE_RECORDING

static final String UNDELETE_RECORDING

Undelete a recording.

This command allows to undelete a previously deleted recording.
This command only works if AutoExpireInsteadOfDelete is set to 1 in MythTV-settings.

There are two variants of this command:

• Undelete recording by programInfo (link)
• Undelete recording by channel-id and recording-start-time (link, since 56)

MythTV protocol example:
426	UNDELETE_RECORDING[]:[]Test[]:[]Mo. Dez 26 15:24:00 2011[]:[][]:[][]:[]1001[]:[]1[]:[]PRO7[]:[]Pro7[]:[]myth://192.168.10.207:6543/1001_20111226152500.mpg[]:[]177472000[]:[]1324909440[]:[]1324909740[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]11[]:[]0[]:[]15[]:[]6[]:[]1324909500[]:[]1324909680[]:[]0[]:[]Default[]:[][]:[][]:[][]:[]1324909692[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]0[]:[]0[]:[]0[]:[]0
1	0

Undelete by ProgramInfo

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   -1=error, 0=ok

Undelete by channel-id and recording-start-time (since 56)

Command parameters:

none

Request parameters:

1. int
   channel id
2. date
   recording start time

Response parameters:

1. int
   -1=error, 0=ok

Since:

36

See Also:

DELETE_RECORDING, IBackend.undeleteRecording(IProgramInfo), Wiki, Constant Field Values

MythTV protocol range: [36,-1)

	Version	Date	Additional Version Info
Added	36	2007-09-11	Changelog, SVN-Rev.: 14483
Changed	56	2009-12-29	Changelog, Changelog, MythBuntu-Release: 10.04, MythTV-Release: 0.23, SVN-Rev.: 23028, SVN-Rev.: 23012
Removed	-1

RESCHEDULE_RECORDINGS

static final String RESCHEDULE_RECORDINGS

Reschedules recordings.

This command forces the backend to reschedule all recordings with the given recording-id.

MythTV protocol example:
Reschedule a given recording (protocol version < 73):
25	RESCHEDULE_RECORDINGS 163
1	1
Rescheduling all recordings (protocol version < 73):
24	RESCHEDULE_RECORDINGS -1
1	1

Command parameters:

1. int
   recording-ID (Use -1 ro reschedule all recordings)

Request parameters:

none

Response parameters:

1. int
   0 | 1

Since:

15

See Also:

IBackend.rescheduleRecordings(java.lang.Integer), Wiki, Constant Field Values

MythTV protocol range: [15,-1)

	Version	Date	Additional Version Info
Added	15	2005-03-23	Changelog, MythTV-Release: 0.18, SVN-Rev.: 5833
Removed	-1

FORGET_RECORDING

static final String FORGET_RECORDING

Forgets a recording.

This command deletes the history of a recording but not the recording itself or its metadata.
The recording is marked as never duplicates, so it can be re-recorded.

This is similar to the option "Forget Old" on MythWeb.

MythTV protocol example:
439	FORGET_RECORDING[]:[]Eine Frage der Ehe[]:[]Til Death[]:[][]:[]comedy[]:[]1010[]:[]6[]:[]ORF1[]:[]ORF1[]:[]myth://192.168.10.207:6543/1010_20120109115200.mpg[]:[]458432000[]:[]1326105301[]:[]1326106801[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]24[]:[]0[]:[]0[]:[]0[]:[]1326106320[]:[]1326106800[]:[]5[]:[]Default[]:[][]:[]58973125[]:[][]:[]1326107293[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]2[]:[]0[]:[]2006
1	0

Command parameters:

none

Request parameters:

1. progInfo
   the recording to forget (if any, see here for all properties)

Response parameters:

1. int
   0 always returns this value.

Since:

00

See Also:

IBackend.forgetRecording(IProgramInfo), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_GETALLPENDING

static final String QUERY_GETALLPENDING

Queries all pending recordings.

MythTV protocol example:
Example with one pending recording:
19	QUERY_GETALLPENDING
364	0[]:[]1[]:[]Charmed - Zauberhafte Hexen[]:[]Besessen[]:[][]:[]Mysteryserie[]:[]19[]:[]3[]:[]PRO7[]:[]PRO 7[]:[][]:[]0[]:[]0[]:[]1202382000[]:[]1202385600[]:[][]:[]0[]:[]0[]:[][]:[]1[]:[]1[]:[]1[]:[]0[]:[]-1[]:[]4[]:[]1[]:[]15[]:[]6[]:[]1202382000[]:[]1202385600[]:[]0[]:[]0[]:[]Default[]:[]0[]:[][]:[]202622814[]:[][]:[]1202371124[]:[]0.000000[]:[]1202338800[]:[]0
Example with no pending recordings:
19	QUERY_GETALLPENDING
7	0[]:[]0

Command parameters:

1. string
   temptable (optional; unknown purpose)
2. int
   recordid (optional; unknown purpose)

Request parameters:

none

Response parameters:

1. int
   indicates whether there are any conflicts (0: No; 1: Yes)
2. int
   the number of programs pending
3. progInfo[]
   a list of recordings (if any)

Since:

00

See Also:

IBackend.queryAllPending(), IRecordingsPending, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_GETALLSCHEDULED

static final String QUERY_GETALLSCHEDULED

Queries all scheduled recordings.

A command to query a list of Program objects which are scheduled to be recorded.

MythTV protocol example:
Example with one scheduled recording:
21	QUERY_GETALLSCHEDULED
352	1[]:[]King of Queens[]:[]Ein Zeichen Gottes[]:[][]:[]Comedyserie[]:[]9[]:[]9[]:[]K1[]:[]KABEL 1[]:[][]:[]0[]:[]0[]:[]1202382600[]:[]1202384400[]:[][]:[]0[]:[]0[]:[][]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]13[]:[]1[]:[]15[]:[]6[]:[]1202382600[]:[]1202384400[]:[]0[]:[]0[]:[]Default[]:[]0[]:[][]:[]96652531[]:[][]:[]1202372524[]:[]0.000000[]:[]1202338800[]:[]0
Example with no scheduled recordings:
21	QUERY_GETALLSCHEDULED
1	0

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   the number of scheduled recordings
2. progInfo[]
   a list of programs (if any, see here for all properties)

Since:

00

See Also:

IBackend.queryAllScheduled(), IRecordingsScheduled, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_GETCONFLICTING

static final String QUERY_GETCONFLICTING

Queries all conflicting recordings.

A command to query a list of conflicting recordings.

Note:
Starting with protocol version 57, the backend seens not to return a conflicting recording anymore, without specifying a recording as request-parameter.

MythTV protocol example:
Example with one conflict (this seems not to work anymore starting with version 57):
20	QUERY_GETCONFLICTING
872	1[]:[]Servus Kasperl[]:[]Kasperl & Buffi[]:[]Heute: Buffi findet auf dem Fensterbrett einen Hut.[]:[][]:[]1000[]:[]2[]:[]ORF1[]:[]ORF 1[]:[]1000_20100514070528.mpg[]:[]0[]:[]76234564[]:[]1273813200[]:[]1273814700[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1273813528[]:[]1273813680[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[][]:[]219655276[]:[][]:[]1273813926[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0
Example with no conflicts (this seems not to work anymore starting with version 57):
20	QUERY_GETCONFLICTING
1	0
Example with a given program and two conflicts:
380	QUERY_GETCONFLICTING[]:[]Sturm der Liebe[]:[][]:[][]:[]familienserie[]:[]1006[]:[]15[]:[]BR3[]:[]BR3[]:[][]:[]0[]:[]1326096301[]:[]1326099301[]:[]0[]:[]mythbuntu11[]:[]1[]:[]0[]:[]0[]:[]1[]:[]7[]:[]17[]:[]1[]:[]15[]:[]6[]:[]1326096001[]:[]1326099301[]:[]0[]:[]Default[]:[][]:[]148753397[]:[][]:[]1326095636[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]2[]:[]2008
758	2[]:[]Lenßen & Partner[]:[]Das Killer-Video[]:[][]:[]krimiserie[]:[]1005[]:[]3[]:[]SAT.1[]:[]SAT.1[]:[]/var/lib/mythtv/recordings[]:[]0[]:[]1326096001[]:[]1326097801[]:[]0[]:[]mythbuntu11[]:[]1[]:[]3[]:[]2[]:[]1[]:[]-1[]:[]16[]:[]1[]:[]15[]:[]6[]:[]1326095701[]:[]1326097801[]:[]0[]:[]Default[]:[][]:[]58414658[]:[][]:[]1326095636[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]0[]:[]2005[]:[]Tagesschau[]:[][]:[][]:[]nachrichten[]:[]1002[]:[]4[]:[]ARD[]:[]ARD[]:[][]:[]0[]:[]1326096001[]:[]1326096181[]:[]0[]:[]mythbuntu11[]:[]1[]:[]4[]:[]3[]:[]1[]:[]-1[]:[]15[]:[]1[]:[]15[]:[]6[]:[]1326096001[]:[]1326096181[]:[]0[]:[]Default[]:[][]:[]212613461[]:[][]:[]1326095636[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]2[]:[]0[]:[]2012

Command parameters:

none

Request parameters:

1. progInfo
   the recording to test for conflicts (mandatory since 57, see here for all properties)

Response parameters:

1. int
   the number of conflicting recordings
2. progInfo[]
   a list of recordings (if any, see here for all properties)

Since:

00

See Also:

IBackend.queryConflicting(), IRecordingsConflicting, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	57	2010-05-16	Changelog, Changelog, SVN-Rev.: 24694, SVN-Rev.: 23636
Removed	-1

QUERY_GETEXPIRING

static final String QUERY_GETEXPIRING

Queries all expiring recordings.

A command to receive a list of expiring programs.

MythTV protocol example:
17	QUERY_GETEXPIRING
872	1[]:[]Servus Kasperl[]:[]Kasperl & Buffi[]:[]Heute: Buffi findet auf dem Fensterbrett einen Hut.[]:[][]:[]1000[]:[]2[]:[]ORF1[]:[]ORF 1[]:[]1000_20100514070528.mpg[]:[]0[]:[]76234564[]:[]1273813200[]:[]1273814700[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1273813528[]:[]1273813680[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[][]:[]219655276[]:[][]:[]1273813926[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   the number of expiring recordings
2. progInfo[]
   a list of recordings (if any, see here for all properties)

Since:

23

See Also:

IBackend.queryExpiring(), IRecordingsExpiring, Wiki, Constant Field Values

MythTV protocol range: [23,-1)

	Version	Date	Additional Version Info
Added	23	2006-01-10	Changelog, SVN-Rev.: 8553
Removed	-1

GET_FREE_RECORDER

static final String GET_FREE_RECORDER

Gets the next free recorder.

This command returns the next free recorder.
This command similar to GET_NEXT_FREE_RECORDER, except that it tries to get a recorder on the local machine if possible.

MythTV protocol example:
17	GET_FREE_RECORDER
24	1[]:[]127.0.0.1[]:[]6543
If no free recorder is available
17	GET_FREE_RECORDER
20	-1[]:[]nohost[]:[]-1

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   recorder id (-1 if no recorder is free)
2. string
   hostname of the recorder (nohost if no recorder is free)
3. int
   port of the recorder (-1 if no recorder is free)

Since:

00

See Also:

IBackend.getFreeRecorder(), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

GET_FREE_RECORDER_COUNT

static final String GET_FREE_RECORDER_COUNT

Gets the amount of free recorders.

This command asks the backend for the number free recorders.
A free recorder is identifed as one that is connected, but not busy or locked.

MythTV protocol example:
23	GET_FREE_RECORDER_COUNT
1	1

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   amount of free recorders

Since:

09

See Also:

IBackend.getFreeRecorderCount(), Wiki, Constant Field Values

MythTV protocol range: [09,-1)

	Version	Date	Additional Version Info
Added	09	2004-06-04	Changelog, SVN-Rev.: 3838
Removed	-1

GET_FREE_RECORDER_LIST

static final String GET_FREE_RECORDER_LIST

Gets all free recorders.

This command asks the backend for a list of free recorders.
A free recorder is one that is connected but not busy or locked.

MythTV protocol example:
22	GET_FREE_RECORDER_LIST
1	1
With multiple recorders:
22	GET_FREE_RECORDER_LIST
7	1[]:[]2
With no free recorders:
22	GET_FREE_RECORDER_LIST
1	0

Command parameters:

none

Request parameters:

none

Response parameters:

1. int[]
   ids of free recorders

Since:

17

See Also:

IBackend.getFreeRecorderIDs(), Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Removed	-1

GET_NEXT_FREE_RECORDER

static final String GET_NEXT_FREE_RECORDER

Gets the next free recorder.

This command queries the next free recorder, starting with given recorder id.
This command similar to GET_FREE_RECORDER, except that it returns the next free recorder, even if it is located on a remote backend.

MythTV protocol example:
29	GET_NEXT_FREE_RECORDER[]:[]-1
24	1[]:[]127.0.0.1[]:[]6543
If no free recorder is available
29	GET_NEXT_FREE_RECORDER[]:[]-1
20	-1[]:[]nohost[]:[]-1

Command parameters:

none

Request parameters:

1. int
   current recorder id (-1 if not specified)

Response parameters:

1. int
   recorder id (-1 if no recorder is free)
2. string
   hostname of the recorder (nohost if no recorder is free)
3. int
   port of the recorder (-1 if no recorder is free)

Since:

03

See Also:

IBackend.getNextFreeRecorder(), IRecorderInfo, Constant Field Values

MythTV protocol range: [03,-1)

	Version	Date	Additional Version Info
Added	03	2004-02-05	Changelog, SVN-Rev.: 3112
Removed	-1

QUERY_RECORDER

static final String QUERY_RECORDER

Queries a recorder.

Since:

00

See Also:

IRecorder, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

SET_NEXT_LIVETV_DIR

static final String SET_NEXT_LIVETV_DIR

Changes LiveTV recording directory.

This command thells the backend where to put the next LiveTV recording.

If a new LiveTV recording was started, the MythTV encoder seems to wait max 500 ms to get the next LiveTV recording directory.
See tv_rec.cpp function WaitForNextLiveTVDir().

MythTV protocol example:
33	SET_NEXT_LIVETV_DIR 3 /tmp/mythtv
2	OK

Command parameters:

1. int
   recorder id
2. string
   dirname

Request parameters:

none

Response parameters:

1. string
   OK | bad

Since:

32

See Also:

IRecorder.setNextLiveTvDirectory(String), Wiki, Constant Field Values

MythTV protocol range: [32,-1)

	Version	Date	Additional Version Info
Added	32	2006-11-30	Changelog, SVN-Rev.: 12151
Removed	-1

SET_CHANNEL_INFO

static final String SET_CHANNEL_INFO

Changes channel infos.

This command allows a frontend to change some channel information, and updates that data in all the currently running recorders.

To fetch the current channel information, QUERY_RECORDER_GET_CHANNEL_INFO can be used.

MythTV protocol example:
On success:
78	SET_CHANNEL_INFO[]:[]1001[]:[]1[]:[]1[]:[]PRO7[]:[]2[]:[]Pro7[]:[]prosieben.de
1	1
On error:
78	SET_CHANNEL_INFO[]:[]1001[]:[]0[]:[]1[]:[]PRO7[]:[]1[]:[]Pro7[]:[]prosieben.de
1	1

Command parameters:

none

Request parameters:

1. int
   channel id (can not be changed)
2. int
   source id (can not be changed)
3. string
   old channel number (required for channel renumbering)
4. string
   channel sign
5. string
   new channel number
6. string
   channel name
7. string
   xmltv id

Response parameters:

1. bool
   0=error, 1=success

Since:

28

See Also:

IBackend.setChannelInfo(java.lang.String, org.jmythapi.IRecorderChannelInfo), Wiki, Constant Field Values

MythTV protocol range: [28,-1)

	Version	Date	Additional Version Info
Added	28	2006-03-28	Changelog, SVN-Rev.: 9524
Removed	-1

QUERY_REMOTEENCODER

static final String QUERY_REMOTEENCODER

Queries a remote encoder.

Since:

00

See Also:

IRemoteEncoder, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

GET_RECORDER_FROM_NUM

static final String GET_RECORDER_FROM_NUM

Gets a recorder by ID.

This command asks a backend for a specific recorder.
The host address and port returned may not be on the originally queried host, if slave backends are used. If the recorder is not valid, -1 will be returned for the port and the host will be nohost.
Note that this does not check if a recorder is busy or locked.

MythTV protocol example:
27	GET_RECORDER_FROM_NUM[]:[]1
18	127.0.0.1[]:[]6543
If no recorder is found
28	GET_RECORDER_FROM_NUM[]:[]20
13	nohost[]:[]-1

Command parameters:

none

Request parameters:

1. int
   recorder id

Response parameters:

1. string
   hostname of the recorder (nohost if no recorder was found)
2. int
   port of the recorder (-1 if no recorder was found)

Since:

00

See Also:

IBackend.getRecorderForNum(int), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

GET_RECORDER_NUM

static final String GET_RECORDER_NUM

Queries the recorder that is recording a given program.

This command asks a backend for a recorder that matches the program info passed in.

The host address and port returned may not be on the originally queried host, if slave backends are used. If the recorder is not valid, -1 will be returned for the port and the host will be nohost.

MythTV protocol example:
466	GET_RECORDER_NUM[]:[]ATV LIFE Hi Society[]:[][]:[][]:[]soziales[]:[]1002[]:[]1[]:[]ATV+[]:[]ATV+[]:[]myth://127.0.0.1:6543/1002_20100523194500.mpg[]:[]0[]:[]37590628[]:[]1274636100[]:[]1274638500[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-2[]:[]3[]:[]0[]:[]15[]:[]6[]:[]1274636700[]:[]1274638500[]:[]0[]:[]36[]:[]Default[]:[]0[]:[][]:[]112543609[]:[][]:[]1274636765[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]0[]:[]2010
24	1[]:[]127.0.0.1[]:[]6543
On error:
490	GET_RECORDER_NUM[]:[]Die Simpsons[]:[][]:[]Hailhouse Blues []:[]kinderprogramm[]:[]1063[]:[]1[]:[]PRO7[]:[]Pro7[]:[]myth://192.168.10.202:6543/1063_20110329201000.mpg[]:[]0[]:[]-2113007680[]:[]1301422500[]:[]1301424000[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]262[]:[]0[]:[]15[]:[]6[]:[]1301422200[]:[]1301424900[]:[]0[]:[]0[]:[]Default[]:[]0[]:[][]:[]216592835[]:[][]:[]1301424901[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]4[]:[]0[]:[]0[]:[]2011
20	-1[]:[]nohost[]:[]-1

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   recorder id (-1 if no recorder was found)
2. string
   hostname of the recorder (nohost if no recorder was found)
3. int
   port of the recorder (-1 if no recorder was found)

Since:

00

See Also:

IBackend.getRecorderNum(org.jmythapi.protocol.response.IProgramInfo), IRecorderInfo, Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_FILETRANSFER

static final String QUERY_FILETRANSFER

Filetransfer queries.

As pre-requirement for this command, a file-transfer connection needs to be established.
All subsequent commands reference the previously announced connection by its socket-id.

The following sub-commands for this command are possible:

• Configure timeout: SET_TIMEOUT
• Check if a file is open: IS_OPEN
• Reopen a file: REOPEN
• Seek within a file: SEEK
• Read a file block: REQUEST_BLOCK
• Write a file block: WRITE_BLOCK
• Finish file-transfer: DONE

Since:

00

See Also:

IFileTransfer, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_GENPIXMAP

static final String QUERY_GENPIXMAP

Deprecated. 61, replaced by QUERY_GENPIXMAP2

Generates a preview image of an recording.

This command asks the backend to generate a preview image of the requested show.

MythTV protocol example:
467	QUERY_GENPIXMAP[]:[]ATV LIFE Hi Society[]:[][]:[][]:[]soziales[]:[]1002[]:[]1[]:[]ATV+[]:[]ATV+[]:[]myth://127.0.0.1:6543/1002_20100523194500.mpg[]:[]0[]:[]37590628[]:[]1274636100[]:[]1274638500[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-2[]:[]3[]:[]0[]:[]15[]:[]6[]:[]1274636700[]:[]1274638500[]:[]0[]:[]36[]:[]Default[]:[]0[]:[][]:[]112543609[]:[][]:[]1274636765[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]0[]:[]2010
2	OK

Command parameters:

1. string
   time_is_seconds (optional)
   since 37
2. long,long
   time (optional)
   since 37
3. string
   fileName (optional)
   since 37
4. int
   width (optional)
   since 37
5. int
   height (optional)
   since 37

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. string
   OK

Since:

00

See Also:

IBackend.queryGenPixmap(IProgramInfo), Wiki, Constant Field Values

MythTV protocol range: [00,61)

	Version	Date	Additional Version Info
Added	00
Changed	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	61	2010-09-03	Changelog, SVN-Rev.: 26106

QUERY_GENPIXMAP2

static final String QUERY_GENPIXMAP2

Generates a preview image of an recording.

This command asks the backend to generate a preview image of the requested show.

This command is a replacement for QUERY_GENPIXMAP.

MythTV protocol example:
442	QUERY_GENPIXMAP2[]:[]do_not_care[]:[]Test5[]:[]Fr. Jul 1 12:29:00 2011[]:[][]:[][]:[]1000[]:[]01[]:[]TEST[]:[]Test[]:[]myth://192.168.10.144:6543/1000_20110701123000.mpg[]:[]65792000[]:[]1309516140[]:[]1309516260[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]5[]:[]0[]:[]15[]:[]6[]:[]1309516200[]:[]1309516260[]:[]2052[]:[]Default[]:[][]:[][]:[][]:[]1309516260[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]0[]:[]0[]:[]0[]:[]0
2	OK

Command parameters:

1. string
   token
2. string
   time_is_seconds (optional)
3. long,long
   time (optional)
4. string
   fileName (optional)
5. int
   width (optional)
6. int
   height (optional)

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. string
   OK

Since:

61, replaces QUERY_GENPIXMAP

See Also:

IBackend.queryGenPixmap2(String, IProgramInfo), Constant Field Values

MythTV protocol range: [61,-1)

	Version	Date	Additional Version Info
Added	61	2010-09-03	Changelog, SVN-Rev.: 26106
Removed	-1

QUERY_PIXMAP_LASTMODIFIED

static final String QUERY_PIXMAP_LASTMODIFIED

Queries the last-modified date of a preview image.

This command asks the backend for the last-modified date of preview image of a given recording.

Starting with protocol 40 this command returns a unix-timestamp instead of a localized date string.

MythTV protocol example:
989	QUERY_PIXMAP_LASTMODIFIED[]:[]Jim Carreys Die Maske[]:[]Komödie / USA / 1994[]:[]Stanley arbeitet in der Kreditabteilung einer großen Bank. Er ist ein großer Fan von Cartoons und Comics. Doch eines Tages ändert sich sein eintöniges Spießerleben drastisch: Als er eine alte grüne Holzmaske findet und diese anprobiert, verschmilzt diese förmlich mit seinem Gesicht und verwandelt ihn in eine Art Superman, der über alle außergewöhnlichen Fähigkeiten von Cartoon-Stars verfügt. Stanley treibt damit allerhand Schabernack und erobert das Herz der schönen Tina.[]:[][]:[]11123[]:[]10123[]:[]PULS 4[]:[]PULS 4[]:[]myth://192.168.10.201:6543/11123_20110313221000.mpg[]:[]0[]:[]-761164196[]:[]1300050920[]:[]1300057620[]:[]0[]:[]0[]:[]734575[]:[]brain[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]313[]:[]0[]:[]0[]:[]0[]:[]1300050600[]:[]1300058520[]:[]0[]:[]1[]:[]Default[]:[]0[]:[][]:[][]:[][]:[]1300819682[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]1[]:[]0[]:[]0[]:[]0
10	1302196901

Command parameters:

none

Request parameters:

1. proginfo
   recording (see here for all properties)

Response parameters:

1. string
   BAD | date: last-modified-date (since 40 a timestamp is returned)
   changed in 40

Since:

17

See Also:

IBackend.queryPixmapLastModified(IProgramInfo), Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	40	2008-02-17	Changelog, SVN-Rev.: 16090
Removed	-1

QUERY_PIXMAP_GET_IF_MODIFIED

static final String QUERY_PIXMAP_GET_IF_MODIFIED

Queries a preview image.

This command can be used to download a preview image.
Optionally it can be specified that the preview image should only be returned if it was recently modified and its file size is lower than the specified maximum.

Use QUERY_PIXMAP_LASTMODIFIED if you only want to check the last modified date of the pixmap.

MythTV protocol example:
If the pixmap was modified:
482	QUERY_PIXMAP_GET_IF_MODIFIED[]:[]-1[]:[]1048576[]:[]Lenßen & Partner[]:[]Das Killer-Video[]:[][]:[]krimiserie[]:[]1005[]:[]3[]:[]SAT.1[]:[]SAT.1[]:[]myth://192.168.10.207:6543/1005_20120109085500.mpg[]:[]887680000[]:[]1326096001[]:[]1326097801[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]16[]:[]0[]:[]0[]:[]0[]:[]1326095700[]:[]1326096600[]:[]4[]:[]Deleted[]:[][]:[]58414658[]:[][]:[]1326096616[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]0[]:[]2005
129115	1326106707[]:[]96808[]:[]52821[]:[]iVBORw0KGgoAAAANSUhEUgAAAUAA ..... ==
If the pixmap as not modified:
465	QUERY_PIXMAP_GET_IF_MODIFIED[]:[]1326279614[]:[]1048576[]:[]Test1[]:[]Di. Jän 10 09:00:00 2012[]:[][]:[][]:[]1001[]:[]1[]:[]PRO7[]:[]Pro7[]:[]myth://192.168.10.207:6543/1001_20120110090000.mpg[]:[]581440000[]:[]1326182400[]:[]1326183000[]:[]0[]:[]mythbuntu11[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]28[]:[]0[]:[]15[]:[]6[]:[]1326182400[]:[]1326183000[]:[]5[]:[]Default[]:[][]:[][]:[][]:[]1326187877[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]0[]:[]0[]:[]0[]:[]0
10	1326279614

Command parameters:

none

Request parameters:

1. int
   unix-timestamp - the last modified timestamp, use -1 if not required
2. int
   max file size - if 0 or the limit is exeeded only the timestamp will be returned.
3. progInfo
   recording (see here for all properties)

Response parameters:

On error:

1. string
   ERROR
2. string
   error message
   1: Parameter list too short | 2: Invalid ProgramInfo | 3: Failed to read preview file | 5: Could not locate mythbackend that made this recording

On warning:

1. string
   WARNING
2. string
   waring message
   1: Preview file too big ... | 2: Could not locate requested file | 4: Preview file is invalid

On success:

1. int
   last-modified timestamp
2. int
   file size
3. int
   checksum
4. bytes
   data

Since:

49

See Also:

IBackend.queryPixmapIfModified(IProgramInfo, java.util.Date, Long), IPixmap, Constant Field Values

MythTV protocol range: [49,-1)

	Version	Date	Additional Version Info
Added	49	2009-10-01	Changelog, SVN-Rev.: 22164
Removed	-1

QUERY_ISRECORDING

static final String QUERY_ISRECORDING

Queries if a backend is recording.

MythTV protocol example:
One LiveTV recording:
17	QUERY_ISRECORDING
7	1[]:[]1
One scheduled recording:
17	QUERY_ISRECORDING
7	1[]:[]0
No recordings:
17	QUERY_ISRECORDING
7	0[]:[]0
No recordings (protocol version 15):
17	QUERY_ISRECORDING
1	0

Command parameters:

none

Request parameters:

none

Response parameters:

1. int
   recordings in progress
2. int
   live tv recordings
   since 40

Since:

00

See Also:

IRecordingStatus, IBackend.queryIsRecording(), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	40	2008-02-17	Changelog, SVN-Rev.: 16090
Removed	-1

MESSAGE

static final String MESSAGE

Message.

This command is sent from a client to the backend.

If the server needs to send a message to the client, a BACKEND_MESSAGE is used instead.

Since:

00

See Also:

Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

FILL_PROGRAM_INFO

static final String FILL_PROGRAM_INFO

Updates the pathname and file-size of a recording.

This command asks the backend to fill in the pathname and filesize fields of a given ProgramInfo record and return it.
If the path is local to the play back host (as specified to the backend), then the returned pathname will be a local filename. Otherwise, it will be a myth URI.

MythTV protocol example:
440	FILL_PROGRAM_INFO[]:[]MythTV-API[]:[]Unknown[]:[][]:[][]:[][]:[]1001[]:[]1[]:[]VOX[]:[]VOX[]:[]/var/lib/mythtv/livetv/1001_20100620200048.mpg[]:[]0[]:[]0[]:[]1277056847[]:[]1277058600[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1277056848[]:[]1277058600[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[][]:[][]:[]1277056847[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]
407	Unknown[]:[][]:[][]:[][]:[]1001[]:[]1[]:[]VOX[]:[]VOX[]:[]myth://mythbox:6543/1001_20100620200048.mpg[]:[]0[]:[]18325548[]:[]1277056847[]:[]1277058600[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1277056848[]:[]1277058600[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[][]:[][]:[]1277056847[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]

Command parameters:

none

Request parameters:

1. progInfo
   recording (see here for all properties)

Response parameters:

1. progInfo
   recording (see here for all properties)

Since:

00

See Also:

IBackend.fillProgramInfo(IProgramInfo, String), IFileTransfer.updateFileSize(), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

LOCK_TUNER

static final String LOCK_TUNER

Locks a tuner.

This command asks the backend to lock a tuner.

Locked tuners will not be used for scheduled recordings and are not available for use by other frontends. The backend will attempt to re-schedule recordings to take this into account. The tuner should be released when no longer required using FREE_TUNER.
If no card ID is specified, the backend will choose an unlocked, unused tuner. ATTENTION: This only works if your frontend is on the same machine as the tuner you are trying to lock.

MythTV protocol example:
12	LOCK_TUNER 1
27	1[]:[]/dev/video0[]:[][]:[]
On error:
12	LOCK_TUNER 1
17	-1[]:[][]:[][]:[]

Command parameters:

1. int
   tuner-id (optional)

Request parameters:

none

Response parameters:

1. int
   tuner-id (-1 if no card can be found with the specified ID; -2 if tuner is already locked)
2. string
   video dev node
3. string
   audio dev node
4. string
   vbi dev node

Since:

00

See Also:

IBackend.lockTuner(Integer), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

FREE_TUNER

static final String FREE_TUNER

Releases a locked tuner.

This command asks the backend to free a previously locked tuner.

MythTV protocol example:
12	FREE_TUNER 1
2	OK
On error:
13	FREE_TUNER 20
6	FAILED

Command parameters:

1. int
   tuner-id

Request parameters:

none

Response parameters:

1. string
   OK | FAILED

Since:

00

See Also:

IBackend.freeTuner(Integer), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_IS_ACTIVE_BACKEND

static final String QUERY_IS_ACTIVE_BACKEND

Checks if a backend is active.

This command checks if the given backend is active.

MythTV protocol example:
35	QUERY_IS_ACTIVE_BACKEND[]:[]mythbox
4	TRUE

Command parameters:

none

Request parameters:

1. string
   hostname

Response parameters:

1. string
   TRUE | FALSE

Since:

00

See Also:

IBackend.isActiveBackend(String), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_ACTIVE_BACKENDS

static final String QUERY_ACTIVE_BACKENDS

Queries the names of all active backends.

This command returns the names of all currently active backends.

MythTV protocol example:
21	QUERY_ACTIVE_BACKENDS
27	2[]:[]mythbox1[]:[]mythbox2

Command parameters:

none

Request parameters:

none

Response parameters:

1. string[]
   the names of all active backends.

Since:

00

See Also:

IBackend.isActiveBackend(String), Constant Field Values

MythTV protocol range: [72,-1)

	Version	Date	Additional Version Info
Added	72	2012-01-29	Changelog, MythBuntu-Release: 12.04, MythTV-Release: 0.25
Removed	-1

QUERY_COMMBREAK

static final String QUERY_COMMBREAK

Queries commerical breaks.

TODO: needs to be implemented.

ATTENTION: The backend crashes if the recording does not exist. Parameters changed in 66

Since:

17

See Also:

Wiki, Constant Field Values

QUERY_CUTLIST

static final String QUERY_CUTLIST

Queries cutlists.

TODO: needs to be implemented.

ATTENTION: The backend crashes if the recording does not exist.
Parameters changed in 66

Since:

17

See Also:

Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_BOOKMARK

static final String QUERY_BOOKMARK

Queries bookmarks.

This command is used to query the bookmark position for a given recording.

ATTENTION: The backend crashes if the recording does not exist.

MythTV protocol example:
No bookmark available:
30	QUERY_BOOKMARK 1002 1312551660
7	0[]:[]0
With a bookmark:
30	QUERY_BOOKMARK 1002 1312551660
9	0[]:[]644

Command parameters:

1. int
   channel-id
2. int
   recording-start-time in seconds

Request parameters:

none

Response parameters:

1. long, long
   bookmark position in frames
   deprecated 66
2. long
   bookmark position in frames
   since 66

Since:

17

See Also:

IBackend.queryBookmark(IProgramInfo), Wiki, Constant Field Values

SET_BOOKMARK

static final String SET_BOOKMARK

Setting bookmarks.

This command is used to set the bookmark for a given recording to the given number of frames.

MythTV protocol example:
34	SET_BOOKMARK 1002 1312551660 0 644
2	OK

Command parameters:

1. int
   channel-id
2. int
   recording-start-time in seconds
3. long, long
   bookmark position in frames
   deprecated 66
4. long64
   bookmark position in frames
   since 66

Request parameters:

none

Response parameters:

1. string
   OK | FAILED

Since:

17

See Also:

IBackend.setBookmark(org.jmythapi.protocol.response.IProgramInfo, java.lang.Long), Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_SETTING

static final String QUERY_SETTING

Queries backend settings.

This command is used to query the remote host for a specific setting.
The backend will look in the MySQL database table 'settings', and attempt to return the value for the given setting. It seems only settings with the hostname set can be retrieved by this call.

MythTV protocol example:
26	QUERY_SETTING mythtv Theme
7	G.A.N.T

Command parameters:

1. string
   hostname
2. string
   settings-name

Request parameters:

none

Response parameters:

1. String
   setting-value (-1 for unknown settings

Since:

17

See Also:

IBackend.querySetting(String, String), Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Removed	-1

SET_SETTING

static final String SET_SETTING

Configure backend settings.

This command is used to set given setting on the remote host.

MythTV protocol example:
20	SET_SETTING mythtv Language DE
2	OK

Command parameters:

1. string
   hostname
2. string
   settings-name
3. string
   settings-value

Request parameters:

none

Response parameters:

1. String
   OK

Since:

17

See Also:

IBackend.setSetting(String, String, String), Wiki, Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Removed	-1

ALLOW_SHUTDOWN

static final String ALLOW_SHUTDOWN

Allows a backend to shut down.

This command signals a backend that a shutdown is allowed again, after a previous call to BLOCK_SHUTDOWN.

MythTV protocol example:
14	ALLOW_SHUTDOWN
2	OK

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   OK

Since:

19

See Also:

IBackend.allowShutdown(), Wiki, Constant Field Values

MythTV protocol range: [19,-1)

	Version	Date	Additional Version Info
Added	19	2005-10-09	Changelog, SVN-Rev.: 7427
Removed	-1

BLOCK_SHUTDOWN

static final String BLOCK_SHUTDOWN

Prevents a backend shutdown.

This command prevents a backend from shutting down until a the next call to ALLOW_SHUTDOWN.

MythTV protocol example:
14	BLOCK_SHUTDOWN
2	OK

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   OK

Since:

19

See Also:

IBackend.blockShutdown(), Wiki, Constant Field Values

MythTV protocol range: [19,-1)

	Version	Date	Additional Version Info
Added	19	2005-10-09	Changelog, SVN-Rev.: 7427
Removed	-1

SHUTDOWN_NOW

static final String SHUTDOWN_NOW

Shutdown a slave backend.

This command can be used to shutdown a slave backend.

MythTV protocol example:
12	SHUTDOWN_NOW

Command parameters:

none

Request parameters:

none

Response parameters:

none

Since:

00

See Also:

IBackend.shutdownNow(), Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

BACKEND_MESSAGE

static final String BACKEND_MESSAGE

Backend Message.

This type of command represents a MythTV event message. params:

1. string
   message
2. string[]
   extra
   since 52

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	52	2009-11-30	Changelog, SVN-Rev.: 22932
Removed	-1

REFRESH_BACKEND

static final String REFRESH_BACKEND

Reloading backend settings.

This command forces the backend to reload the backend settings.

MythTV protocol example:
15	REFRESH_BACKEND
2	OK

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   OK

Since:

05

See Also:

IBackend.refreshBackend(), Constant Field Values

MythTV protocol range: [05,-1)

	Version	Date	Additional Version Info
Added	05	2004-04-10	Changelog, SVN-Rev.: 3503
Removed	-1

OK

static final String OK

OK.

Since:

16

See Also:

Constant Field Values

MythTV protocol range: [16,-1)

	Version	Date	Additional Version Info
Added	16	2005-05-03	Changelog, SVN-Rev.: 6284
Removed	-1

UNKNOWN_COMMAND

static final String UNKNOWN_COMMAND

Unknown Command.

Since:

16

See Also:

Constant Field Values

MythTV protocol range: [16,-1)

	Version	Date	Additional Version Info
Added	16	2005-05-03	Changelog, SVN-Rev.: 6284
Removed	-1

QUERY_TIME_ZONE

static final String QUERY_TIME_ZONE

Queries the timezone of a backend.

MythTV protocol example:
15	QUERY_TIME_ZONE
46	Europe/Vienna[]:[]7200[]:[]2010-05-24T11:55:14

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   timezone
2. int
   UTC offset
3. date
   current date/time

Since:

42

See Also:

IBackend.queryTimeZone(), ITimezone, SVN Rev. 18574, Wiki, Constant Field Values

MythTV protocol range: [42,-1)

	Version	Date	Additional Version Info
Added	42	2008-10-07	Changelog, SVN-Rev.: 18574
Removed	-1

QUERY_FILE_EXISTS

static final String QUERY_FILE_EXISTS

Check the existence of a remote file.

This command asks the backend to query for the existence of a remote file.

MythTV protocol example:
Example Live-TV:
57	QUERY_FILE_EXISTS[]:[]/1002_20100524113828.mpg[]:[]LiveTV
53	1[]:[]/var/lib/mythtv/livetv//1002_20100524113828.mpg
Example Recording:
59	QUERY_FILE_EXISTS[]:[]/11123_20110313221000.mpg[]:[]Default
58	1[]:[]/var/lib/mythtv/recordings//11123_20110313221000.mpg
Example Preview Image:
62	QUERY_FILE_EXISTS[]:[]/1063_20110329201000.mpg.png[]:[]Default
61	1[]:[]/var/lib/mythtv/recordings//1063_20110329201000.mpg.png
If the file could not be found:
33	QUERY_FILE_EXISTS[]:[]XYZ[]:[]ABC
1	0
Protocol version 63 example:
58	QUERY_FILE_EXISTS[]:[]/1000_20110701123000.mpg[]:[]Default
193	1[]:[]/var/lib/mythtv/recordings//1000_20110701123000.mpg[]:[]2049[]:[]136043[]:[]33188[]:[]1[]:[]109[]:[]117[]:[]0[]:[]65792000[]:[]4096[]:[]128504[]:[]1309516209[]:[]1309516260[]:[]1309516260

Command parameters:

none

Request parameters:

1. string
   the remote file-name
2. string
   the storage group name (optional)
   since 65

Response parameters:

1. int
   0=not found, 1=exists
2. string
   Filepath
3. int
   device-id
   since 59
4. int
   inode number
   since 59
5. int
   protection mode
   since 59
6. int
   number of hard links
   since 59
7. int
   user id
   since 59
8. int
   group id
   since 59
9. int
   special device-id
   since 59
10. int
    file size
    since 59
11. int
    blocksize
    since 59
12. int
    blocks
    since 59
13. date
    last access time
    since 59
14. date
    last modified time
    since 59
15. date
    last status change
    since 59

Since:

49

See Also:

IBackend.queryFileExists(IProgramInfo), IBackend.queryFileExists(String, String), Constant Field Values

MythTV protocol range: [49,-1)

	Version	Date	Additional Version Info
Added	49	2009-10-01	Changelog, SVN-Rev.: 22164
Changed	59	2010-08-26	Changelog, SVN-Rev.: 25858
Changed	65	2011-03-08	Changelog
Removed	-1

QUERY_FILE_HASH

static final String QUERY_FILE_HASH

Query a file hash value.

This command asks the backend to generate a has value for a backend file.

MythTV protocol example:
60	QUERY_FILE_HASH[]:[]/1002_20100523194500.mpg.png[]:[]Default
16	75aa72141cd08662
Protocol Version 69 example:
77	QUERY_FILE_HASH[]:[]1011_20120216191600.mpg.png[]:[]Default[]:[]mythbuntu1125
16	64f9b17040b23f5f

Command parameters:

none

Request parameters:

1. string
   the remote file-name
2. string
   the storage group name
3. string
   host name
   since 69

Response parameters:

1. String
   hash-value

Since:

51

See Also:

IBackend.queryFileHash(String, String), Constant Field Values

MythTV protocol range: [51,-1)

	Version	Date	Additional Version Info
Added	51	2009-11-23	Changelog, SVN-Rev.: 22892
Changed	69	2011-07-11	Changelog
Removed	-1

GO_TO_SLEEP

static final String GO_TO_SLEEP

Put to sleep a backend.

This command allows to put a slave-backend to sleep on demand by the master-backend.

MythTV protocol example:
On success:
11	GO_TO_SLEEP
2	OK
On error:
11	GO_TO_SLEEP
28	ERROR: SleepCommand is empty

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   OK | ERROR: xxx

Since:

45

See Also:

IBackend.goToSleep(), Wiki, Constant Field Values

MythTV protocol range: [45,-1)

	Version	Date	Additional Version Info
Added	45	2009-05-09	Changelog, SVN-Rev.: 20523
Removed	-1

QUERY_HOSTNAME

static final String QUERY_HOSTNAME

Query hostname.

A command to determine the hostname of a backend.

MythTV protocol example:
14	QUERY_HOSTNAME
7	mythbox

Command parameters:

none

Request parameters:

none

Response parameters:

1. String
   hostname

Since:

50

See Also:

IBackend.queryHostname(), Constant Field Values

MythTV protocol range: [50,-1)

	Version	Date	Additional Version Info
Added	50	2009-10-02	Changelog, MythTV-Release: 0.22, SVN-Rev.: 22170
Removed	-1

QUERY_SG_GETFILELIST

static final String QUERY_SG_GETFILELIST

Query storage group.

A command to query the a list of files from the remote storage group.

MythTV protocol example:
80	QUERY_SG_GETFILELIST[]:[]brain[]:[]Default[]:[]/var/lib/mythtv/recordings/[]:[]0
1318	file::11101_20101211173500.mpg.idx::1099180[]:[]file::11101_20101211180000.mpg.idx::1152150[]:[]file::11101_20110102022000.mpg.idx::6257696[]:[]file::11120_20101211155800.mpg.idx::6491684[]:[]file::11123_20110109020100.mpg.png.new::0[]:[]file::11123_20110313221000.mpg::3533803100[]:[]file::11123_20110313221000.mpg.64.100x56.png::9512[]:[]file::11123_20110313221000.mpg.png::78698[]:[]file::11123_20110321200900.mpg::3815729968[]:[]file::11123_20110321200900.mpg.64.100x75.png::11611[]:[]file::11123_20110321200900.mpg.png::75487[]:[]file::11123_20110326225800.mpg::4360045804[]:[]file::11123_20110326225800.mpg.64.100x75.png::9877[]:[]file::11123_20110326225800.mpg.png::82990[]:[]file::11123_20110327201000.mpg::5503386604[]:[]file::11123_20110327201000.mpg.64.100x75.png::8396[]:[]file::11123_20110327201000.mpg.png::63560[]:[]file::11123_20110328200900.mpg::3980990052[]:[]file::11123_20110328200900.mpg.64.100x56.png::9086[]:[]file::11123_20110328200900.mpg.png::71258[]:[]file::11123_20110329200800.mpg::4834346868[]:[]file::11123_20110329200800.mpg.64.100x75.png::12481[]:[]file::11123_20110329200800.mpg.png::75233[]:[]file::11123_20110331200900.mpg::4408794016[]:[]file::11123_20110331200900.mpg.64.100x75.png::15014[]:[]file::11123_20110331200900.mpg.png::96947[]:[]file::11123_20110401233600.mpg.png::50061
Example 2 (with fileNamesOnly and all paths):
54	QUERY_SG_GETFILELIST[]:[]brain[]:[]Default[]:[]/[]:[]1
932	11101_20101211173500.mpg.idx[]:[]11101_20101211180000.mpg.idx[]:[]11101_20110102022000.mpg.idx[]:[]11120_20101211155800.mpg.idx[]:[]11123_20110109020100.mpg.png.new[]:[]11123_20110313221000.mpg[]:[]11123_20110313221000.mpg.64.100x56.png[]:[]11123_20110313221000.mpg.png[]:[]11123_20110321200900.mpg[]:[]11123_20110321200900.mpg.64.100x75.png[]:[]11123_20110321200900.mpg.png[]:[]11123_20110326225800.mpg[]:[]11123_20110326225800.mpg.64.100x75.png[]:[]11123_20110326225800.mpg.png[]:[]11123_20110327201000.mpg[]:[]11123_20110327201000.mpg.64.100x75.png[]:[]11123_20110327201000.mpg.png[]:[]11123_20110328200900.mpg[]:[]11123_20110328200900.mpg.64.100x56.png[]:[]11123_20110328200900.mpg.png[]:[]11123_20110329200800.mpg[]:[]11123_20110329200800.mpg.64.100x75.png[]:[]11123_20110329200800.mpg.png[]:[]11123_20110331200900.mpg[]:[]11123_20110331200900.mpg.64.100x75.png[]:[]11123_20110331200900.mpg.png[]:[]11123_20110401233600.mpg.png

Command parameters:

none

Request parameters:

1. string
   hostname
2. string
   storage group
3. string
   path name
4. boolean
   fileNamesOnly
   since 49

Response parameters:

1. list
   sequence of file-info objects

Since:

44

See Also:

IBackend.queryStorageGroupFileList(String, String, String, boolean), Wiki, Constant Field Values

MythTV protocol range: [44,-1)

	Version	Date	Additional Version Info
Added	44	2009-02-12	Changelog, SVN-Rev.: 19978
Changed	49	2009-10-01	Changelog, SVN-Rev.: 22164
Removed	-1

QUERY_SG_FILEQUERY

static final String QUERY_SG_FILEQUERY

Query storage group file.

A command to query the a single file from the remote storage group.

MythTV protocol example:
97	QUERY_SG_FILEQUERY[]:[]brain[]:[]Default[]:[]/var/lib/mythtv/recordings//11123_20110313221000.mpg
82	/var/lib/mythtv/recordings//11123_20110313221000.mpg[]:[]1300058521[]:[]3533803100
If the slave is not reachable:
46	QUERY_SG_FILEQUERY[]:[]unknown[]:[]ABC[]:[]DEF
29	SLAVE UNREACHABLE: []:[]brain
If the file could not be found:
44	QUERY_SG_FILEQUERY[]:[]brain[]:[]ABC[]:[]DEF
10	EMPTY LIST

Command parameters:

none

Request parameters:

1. string
   hostname (since 58 the backend IP can be used as well).
   changed in 58
2. string
   storage group
3. string
   path to file (since 58 a relative pathname can be used as well).
   changed in 58

Response parameters:

1. string
   file name
2. int
   last modified time
3. long
   file size

Since:

44

See Also:

IStorageGroupFile, IBackend.queryStorageGroupFile(String, String, String), Wiki, Constant Field Values

MythTV protocol range: [44,-1)

	Version	Date	Additional Version Info
Added	44	2009-02-12	Changelog, SVN-Rev.: 19978
Changed	58	2010-07-17	Changelog, Changelog, Changelog, SVN-Rev.: 25362, SVN-Rev.: 25229
Removed	-1

DOWNLOAD_FILE

static final String DOWNLOAD_FILE

Downloads a file on the backend.

A command to instruct the backend to download a remote file into a local storage group asynchronously.

The command takes a URL, Storage Group name, and destination filename as arguments. The reply contains the myth:// URI of the file downloaded.

See BACKEND_MESSAGE_DOWNLOAD_FILE how to receive notifications about an in progress or finished download job.

MythTV protocol example:
101	DOWNLOAD_FILE[]:[]http://upload.wikimedia.org/wikipedia/de/7/7c/ORF-Logo.svg[]:[]Default[]:[]logo.svg
50	OK[]:[]myth://Default@192.168.10.207:6543/logo.svg

Command parameters:

none

Request parameters:

1. string
   url to download
2. string
   storage-group name
3. string
   destination file-name

Response parameters:

1. string
   OK | ERROR
2. string
   myth URI

Since:

58

See Also:

IBackend.downloadFile(java.net.URI, java.lang.String, java.lang.String), Constant Field Values

MythTV protocol range: [58,-1)

	Version	Date	Additional Version Info
Added	58	2010-07-17	Changelog, Changelog, Changelog, SVN-Rev.: 25362, SVN-Rev.: 25229
Removed	-1

DOWNLOAD_FILE_NOW

static final String DOWNLOAD_FILE_NOW

Downloads a file on the backend immediately.

A command to instruct the backend to download a remote file into a local storage group synchronously.

The command takes a URL, Storage Group name, and destination filename as arguments. The reply contains the myth:// URI of the file downloaded.

MythTV protocol example:
105	DOWNLOAD_FILE_NOW[]:[]http://upload.wikimedia.org/wikipedia/de/7/7c/ORF-Logo.svg[]:[]Default[]:[]logo.svg
50	OK[]:[]myth://Default@192.168.10.207:6543/logo.svg

Command parameters:

none

Request parameters:

1. string
   url to download
2. string
   storage-group name
3. string
   destination file-name

Response parameters:

1. string
   OK | ERROR
2. string
   myth URI

Since:

58

See Also:

IBackend.downloadFileNow(java.net.URI, java.lang.String, java.lang.String), Constant Field Values

MythTV protocol range: [58,-1)

	Version	Date	Additional Version Info
Added	58	2010-07-17	Changelog, Changelog, Changelog, SVN-Rev.: 25362, SVN-Rev.: 25229
Removed	-1

SCAN_VIDEOS

static final String SCAN_VIDEOS

Scan video folder.

This command triggers the scanning of all video folders.

Command parameters:

none

Request parameters:

none

Response parameters:

1. string
   OK | ERROR

Since:

64

See Also:

IBackend.scanVideos(), Constant Field Values

MythTV protocol range: [64,-1)

	Version	Date	Additional Version Info
Added	64	2010-11-20	Changelog, SVN-Rev.: 27308
Removed	-1

DELETE_FILE

static final String DELETE_FILE

Delete a remote file.

This command allows to delete a remote file.

MythTV protocol example:
37	DELETE_FILE[]:[]/logo.svg[]:[]Default
1	1

Command parameters:

none

Request parameters:

1. string
   filename
2. string
   storage-group
   since 47

Response parameters:

1. string
   0 | 1
2. string
   myth URI

Since:

46

See Also:

IBackend.deleteFile(java.net.URI), Constant Field Values

MythTV protocol range: [46,-1)

	Version	Date	Additional Version Info
Added	46	2009-08-08	Changelog, SVN-Rev.: 21158
Changed	47	2009-08-16	Changelog, SVN-Rev.: 21298
Removed	-1

ANN_PLAYBACK

static final String ANN_PLAYBACK

Announces a client as playback client.

This command registers a client to the backend and announces a blocking playback connection.

Note: This connection type blocks a shutdown of the backend.

MythTV protocol example:
23	ANN Playback sycamore 0
2	OK

Command parameters:

1. string
   Playback
2. string
   host
3. int
   events-mode (see here for all pssible events)
   changed 57

Request parameters:

none

Response parameters:

1. string
   OK

Since:

00

See Also:

Wiki, IBackend.annotatePlayback(), ANN, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	57	2010-05-16	Changelog, Changelog, SVN-Rev.: 24694, SVN-Rev.: 23636
Removed	-1

ANN_SLAVEBACKEND

static final String ANN_SLAVEBACKEND

Announces a client as slave backend.

This command registers a client to the backend and announces a slave backend connection.

TODO: needs to be implemented.

params:

1. IPaddress

Since:

00

See Also:

Wiki, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

ANN_MEDIASERVER

static final String ANN_MEDIASERVER

Announces a client as mediaserver.

This command registers a client to the backend and announces a media-server connection.

TODO: needs to be implemented

Since:

68

See Also:

Constant Field Values

MythTV protocol range: [68,-1)

	Version	Date	Additional Version Info
Added	68	2011-07-09	Changelog
Removed	-1

ANN_RING_BUFFER

static final String ANN_RING_BUFFER

Deprecated. 20

Announces ringbuffer access.

This command registers a client to the backend and announces a ringbuffer connection.

MythTV protocol example:
25	ANN RingBuffer sycamore 1
2	OK

Command parameters:

1. string
   RingBuffer
2. string
   host
3. int
   recorder nr

Request parameters:

none

Response parameters:

1. string
   ok

Since:

00

See Also:

ANN, IRecorder.annotateRingBuffer(), Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

ANN_FILE_TRANSFER

static final String ANN_FILE_TRANSFER

Announces a file transfer.

This command registers a client to the backend and announces a file-transfer connection.

MythTV protocol example:
Version 15:
66	ANN FileTransfer mythtv[]:[]/home/mythtv/.mythtv/channels/pro7.gif
23	OK[]:[]17[]:[]0[]:[]704
Version 44:
64	ANN FileTransfer mythtv 0 -1[]:[]/channels/atv_at.jpg[]:[]Default
24	OK[]:[]31[]:[]0[]:[]5752
Version 66:
64	ANN FileTransfer mythtv 0 -1[]:[]/channels/atv_at.jpg[]:[]Default
18	OK[]:[]31[]:[]5752
Version 66 (with timeout parameter)
103	ANN FileTransfer mythClient 0 1 2000[]:[]myth://192.168.10.207:6543/1018_20120109091500.mpg[]:[]Default
29	OK[]:[]34[]:[]0[]:[]121477152

Command parameters:

1. string
   FileTransfer
2. string
   hostname
3. int
   writeMode
   since 46
4. int
   usereadahead
   since 29
5. int
   retries
   since 29, deprecated 60
6. int
   timeout_ms
   since 60

Request parameters:

1. string
   name of the file to transfer
2. string
   storage-group
   since 44
3. string[]
   checkfiles (optional)

Response parameters:

1. string
   OK
2. int
   socket id
3. long,long
   filesize
   deprecated 66
4. long
   filesize
   since 66

Since:

00

See Also:

Wiki, IBackend.annotateFileTransfer(org.jmythapi.protocol.response.IProgramInfo), IFileTransfer, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	29	2006-04-01	Changelog, SVN-Rev.: 9592
Changed	44	2009-02-12	Changelog, SVN-Rev.: 19978
Changed	46	2009-08-08	Changelog, SVN-Rev.: 21158
Changed	60	2010-09-03	Changelog, SVN-Rev.: 26101
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

ANN_MONITOR

static final String ANN_MONITOR

Announces a client as monitoring client.

This command registers a client to the backend and announces a monitoring connection.

Note: This connection type does not block a shutdown of the backend.

MythTV protocol example:
24	ANN Monitor MythClient 0
2	OK

Command parameters:

1. string
   Monitor
2. string
   hostname
3. int
   events-mode (see here for all pssible events)
   changed 57

Request parameters:

none

Response parameters:

1. string
   OK

Since:

22

See Also:

Wiki, IBackend.annotateMonitor(), Constant Field Values

MythTV protocol range: [22,-1)

	Version	Date	Additional Version Info
Added	22	2005-11-15	Changelog, SVN-Rev.: 7883
Changed	57	2010-05-16	Changelog, Changelog, SVN-Rev.: 24694, SVN-Rev.: 23636
Removed	-1

QUERY_FILETRANSFER_IS_OPEN

static final String QUERY_FILETRANSFER_IS_OPEN

Filetransfer - Checks if a file is open.

This command queries, whether a file socket is currently open.

MythTV protocol example:
33	QUERY_FILETRANSFER 17[]:[]IS_OPEN
1	1

Command parameters:

1. int
   socket id

Request parameters:

1. string
   IS_OPEN

Response parameters:

1. int
   1=open, 0=closed

Since:

00

See Also:

IFileTransfer.isOpen(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_FILETRANSFER_DONE

static final String QUERY_FILETRANSFER_DONE

Filetransfer - Finish file-transfer.

MythTV protocol example:
30	QUERY_FILETRANSFER 17[]:[]DONE
2	ok

Command parameters:

1. int
   socket id

Request parameters:

1. string
   DONE

Response parameters:

1. string
   OK

Since:

00

See Also:

IFileTransfer.done(), ITransferable.close(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_FILETRANSFER_REQUEST_BLOCK

static final String QUERY_FILETRANSFER_REQUEST_BLOCK

Filetransfer - Request a file block.

MythTV protocol example:
49	QUERY_FILETRANSFER 17[]:[]REQUEST_BLOCK[]:[]65536
5	65536

Command parameters:

1. int
   socket id

Request parameters:

1. string
   REQUEST_BLOCK
2. int
   the size of the block to request

Response parameters:

1. int
   read byte count

Since:

00

See Also:

IFileTransfer.requestBlock(int), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_FILETRANSFER_SEEK

static final String QUERY_FILETRANSFER_SEEK

Filetransfer - Seek within a file.

This command wraps the file "seek" function.
The pos and curpos fields are combined into a larger "long long" data type. This returns two values, a split "long long" value for the result.

MythTV protocol example:
64	QUERY_FILETRANSFER 43[]:[]SEEK[]:[]0[]:[]0[]:[]1[]:[]0[]:[]10000
11	0[]:[]10000

Command parameters:

1. int
   socket id

Request parameters:

1. string
   SEEK
2. int,int
   pos
   deprecated 66
3. long
   pos
   since 66
4. int
   whence
5. int,int
   curpos
   deprecated 66
6. long
   curpos
   since 66

Response parameters:

1. int,int
   curpos
   deprecated 66
2. long
   curpos
   since 66

Since:

00

See Also:

IFileTransfer#seek(long, long, org.jmythapi.protocol.response.IFileTransfer.Seek), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_FILETRANSFER_SET_TIMEOUT

static final String QUERY_FILETRANSFER_SET_TIMEOUT

Filetransfer - Configure timeout.

This command sets whether reading from a file should have a fast or slow timeout.
Slow timeouts are used for live TV ring buffers, and is three seconds. Fast timeous are used for static files, and are 0.12 seconds.

MythTV protocol example:
43	QUERY_FILETRANSFER 36[]:[]SET_TIMEOUT[]:[]1
2	ok

Command parameters:

1. int
   socket id

Request parameters:

1. string
   SET_TIMEOUT
2. int
   1=fast, 0=slow timeout

Response parameters:

1. string
   ok

Since:

28

See Also:

IFileTransfer.setTimeout(boolean), Constant Field Values

MythTV protocol range: [28,-1)

	Version	Date	Additional Version Info
Added	28	2006-03-28	Changelog, SVN-Rev.: 9524
Removed	-1

QUERY_FILETRANSFER_WRITE_BLOCK

static final String QUERY_FILETRANSFER_WRITE_BLOCK

Filetransfer - Write a file block.

TODO: needs to be implemented.

Since:

46

See Also:

Constant Field Values

MythTV protocol range: [46,-1)

	Version	Date	Additional Version Info
Added	46	2009-08-08	Changelog, SVN-Rev.: 21158
Removed	-1

QUERY_FILETRANSFER_REOPEN

static final String QUERY_FILETRANSFER_REOPEN

Filetransfer - Reopen a file.

TODO: needs to be implemented.

Command parameters:

1. string
   REOPEN
2. string
   filename (optional, if another file should be opened)

Request parameters:

none

Response parameters:

1. boolean
   1=ok, 0=error

Since:

70

See Also:

Constant Field Values

MythTV protocol range: [70,-1)

	Version	Date	Additional Version Info
Added	70	2011-11-30	Changelog
Removed	-1

QUERY_RECORDING_BASENAME

static final String QUERY_RECORDING_BASENAME

Queries a single recording by basename.

MythTV protocol example:
48	QUERY_RECORDING BASENAME 1057_20100811133747.mpg
443	OK[]:[]Tom auf heißer Spur[]:[]Der Kinderzimmer-Kobold[]:[][]:[][]:[]1057[]:[]1[]:[]ORF 1[]:[]ORF 1[]:[]1057_20100811133747.mpg[]:[]0[]:[]88213944[]:[]1281525300[]:[]1281526800[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1281526667[]:[]1281526800[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]257651874[]:[][]:[]1281526803[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]1[]:[]2[]:[]0[]:[]

Command parameters:

1. string
   BASENAME
2. string
   basename (format: <channelId>_<recordStartingTime>.mpg, e.g. 1057_20100811133747.mpg)

Request parameters:

none

Response parameters:

1. string
   OK | ERROR
2. progInfo
   recording (see here for all properties)

Since:

32

See Also:

IBackend.queryRecording(String), QUERY_RECORDING, Wiki, Constant Field Values

QUERY_RECORDING_TIMESLOT

static final String QUERY_RECORDING_TIMESLOT

Queries a single recording by channel-id and recording-start-time.

MythTV protocol example:
49	QUERY_RECORDING TIMESLOT 1057 2010-08-11T13:37:47
443	OK[]:[]Tom auf heißer Spur[]:[]Der Kinderzimmer-Kobold[]:[][]:[][]:[]1057[]:[]1[]:[]ORF 1[]:[]ORF 1[]:[]1057_20100811133747.mpg[]:[]0[]:[]88213944[]:[]1281525300[]:[]1281526800[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1281526667[]:[]1281526800[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]257651874[]:[][]:[]1281526803[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]1[]:[]2[]:[]0[]:[]

Command parameters:

1. string
   TIMESLOT
2. int
   channel-ID (e.g. 1058)
3. date
   recording-start-time (e.g. 2010-08-11T13:37:47)

Request parameters:

none

Response parameters:

1. string
   OK | ERROR
2. progInfo
   recording (see here for all properties)

Since:

32

See Also:

IBackend.queryRecording(Integer, java.util.Date), QUERY_RECORDING, Wiki, Constant Field Values

MythTV protocol range: [32,-1)

	Version	Date	Additional Version Info
Added	32	2006-11-30	Changelog, SVN-Rev.: 12151
Removed	-1

QUERY_REMOTEENCODER_GET_STATE

static final String QUERY_REMOTEENCODER_GET_STATE

Queries the state of the remote encoder.

MythTV protocol example:
35	QUERY_REMOTEENCODER 1[]:[]GET_STATE
1	0

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_STATE

Response parameters:

1. int
   state (See here for all states)

Since:

00

See Also:

IRemoteEncoder.getState(), IRemoteEncoderState, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_REMOTEENCODER_GET_FLAGS

static final String QUERY_REMOTEENCODER_GET_FLAGS

Queries the remote encoder flags.

MythTV protocol example:
35	QUERY_REMOTEENCODER 1[]:[]GET_FLAGS
10	1073741826

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_FLAGS

Response parameters:

1. int
   flags - See here for all flags

Since:

37

See Also:

IRemoteEncoder.getFlags(), IRemoteEncoderFlags, Constant Field Values

MythTV protocol range: [37,-1)

	Version	Date	Additional Version Info
Added	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	-1

QUERY_REMOTEENCODER_IS_BUSY

static final String QUERY_REMOTEENCODER_IS_BUSY

Query the remote-encoder busy status.

true if the recorder is busy, or will be within the next time_buffer seconds.

MythTV protocol example:
Example for a busy encoder (Protocol Version 56)
33	QUERY_REMOTEENCODER 1[]:[]IS_BUSY
46	1[]:[]Tuner 1[]:[]1[]:[]1[]:[]1[]:[]0[]:[]1002
Example for an idle encoder (Protocol Version 56):
33	QUERY_REMOTEENCODER 1[]:[]IS_BUSY
43	0[]:[]<EMPTY>[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0
Example for an idle encoder (Protocol Version 15):
33	QUERY_REMOTEENCODER 1[]:[]IS_BUSY
1	0

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   IS_BUSY
2. int
   time_buffer - in seconds (optional)
   since 37

Response parameters:

1. bool
   busy status - 1=busy, 0=idle
2. int
   source id
   since 37
3. int
   input id
   since 37
4. int
   card id
   since 37
5. int
   multiplex id
   since 37
6. int
   live-tv order
   since 71

Since:

00

See Also:

IRemoteEncoder.isBusy(), IRemoteEncoder.getBusyStatus(), IRemoteEncoderBusyStatus, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	37	2008-01-14	Changelog, SVN-Rev.: 15437
Changed	71	2012-01-15	Changelog
Removed	-1

QUERY_REMOTEENCODER_MATCHES_RECORDING

static final String QUERY_REMOTEENCODER_MATCHES_RECORDING

Checks if a remote encoder is recording the given program.

This command is used to check if the given encododer is currently recording the given program.

MythTV protocol example:
451	QUERY_REMOTEENCODER 1[]:[]MATCHES_RECORDING[]:[]Unknown[]:[][]:[][]:[][]:[]1001[]:[]1[]:[]VOX[]:[]VOX[]:[]/var/lib/mythtv/livetv/1001_20100622073520.mpg[]:[]0[]:[]0[]:[]1277184920[]:[]1277186400[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1277184920[]:[]1277186400[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[][]:[][]:[]1277184920[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]
1	1

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   MATCHES_RECORDING
2. progInfo
   recording (see here for all properties)

Response parameters:

1. bool
   0=no, 1=yes

Since:

00

See Also:

IRemoteEncoder.matchesRecording(org.jmythapi.protocol.response.IProgramInfo), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_REMOTEENCODER_START_RECORDING

static final String QUERY_REMOTEENCODER_START_RECORDING

Start recording of a program.

This command tells the encoder to start recording the program as soon as possible.

Command parameters:

1. int
   encoder id

Request parameters:

1. string START_RECORDING
2. progInfo
   recording (see here for all properties)

Response parameters:

1. int
   +1=recording started, -1=encoder is busy, 0=unknown
   deprecated 66
2. int
   recording-status
   since 66

Since:

00

See Also:

IRemoteEncoder.startRecording(IProgramInfo), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_REMOTEENCODER_RECORD_PENDING

static final String QUERY_REMOTEENCODER_RECORD_PENDING

Start recording of a pending program.

Tells the encoder that there is a pending recording in "secsleft" seconds.

TODO: needs to be implemented.

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   RECORD_PENDING
2. int
   secsleft - seconds to wait before starting recording
3. boolean haslate - if true, a later non-conflicting showing is available
   since 37
4. progInfo
   recording (see here for all properties)

Response parameters:

1. string
   ok

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	-1

QUERY_REMOTEENCODER_CANCEL_NEXT_RECORDING

static final String QUERY_REMOTEENCODER_CANCEL_NEXT_RECORDING

Cancel the next recording.

This command tells the encoder to cancel the next recording.
This is used when the user is watching "Live TV" and does not want to allow the recorder to be taken for a pending recording.

MythTV protocol example:
Cancel next recording:
53	QUERY_REMOTEENCODER 1[]:[]CANCEL_NEXT_RECORDING[]:[]1
2	ok
Allow next recording:
53	QUERY_REMOTEENCODER 1[]:[]CANCEL_NEXT_RECORDING[]:[]0
2	ok

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   CANCEL_NEXT_RECORDING
2. int
   0=cancel, 1=allow

Response parameters:

1. string
   ok

Since:

37

See Also:

IRemoteEncoder.cancelNextRecording(Boolean), BACKEND_MESSAGE_ASK_RECORDING, Constant Field Values

MythTV protocol range: [37,-1)

	Version	Date	Additional Version Info
Added	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	-1

QUERY_REMOTEENCODER_STOP_RECORDING

static final String QUERY_REMOTEENCODER_STOP_RECORDING

Stop recording.

This command stops a currently active recording on the given recoder.

MythTV protocol example:
40	QUERY_REMOTEENCODER 1[]:[]STOP_RECORDING
2	OK

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   STOP_RECORDING

Response parameters:

1. string
   ok

Since:

37

See Also:

IRemoteEncoder.stopRecording(), Constant Field Values

MythTV protocol range: [37,-1)

	Version	Date	Additional Version Info
Added	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	-1

QUERY_REMOTEENCODER_GET_MAX_BITRATE

static final String QUERY_REMOTEENCODER_GET_MAX_BITRATE

Get maximum bitrate.

This command queries the maximum bitrate the encoder can output.

MythTV protocol example:
Protocol version 65 example:
41	QUERY_REMOTEENCODER 2[]:[]GET_MAX_BITRATE
14	0[]:[]10080000
Protocol version 66 example:
41	QUERY_REMOTEENCODER 2[]:[]GET_MAX_BITRATE
8	10080000

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_MAX_BITRATE

Response parameters:

1. int,int
   maxBitRate
   deprecated 66
2. long
   maxBitRate
   since 66

Since:

17

See Also:

Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_REMOTEENCODER_GET_CURRENT_RECORDING

static final String QUERY_REMOTEENCODER_GET_CURRENT_RECORDING

Queries current recording.

This command queries the encoders current recording.
This command was introduced to "find out if the slave backend is recording something the master backend thinks should be done by now."

MythTV protocol example:
47	QUERY_REMOTEENCODER 2[]:[]GET_CURRENT_RECORDING
639	Schlimmer geht's immer[]:[][]:[]Als Ganove Kevin das Haus von Mr. Fairbanks ausräumen will, wird er von ihm ertappt und der Polizei übergeben. Zuvor nimmt Fairbanks ihm noch dessen Ring ab. Der bestohlene Dieb sinnt auf Rache...[]:[]spielfilm[]:[]1002[]:[]1[]:[]ATV+[]:[]ATV+[]:[]/var/lib/mythtv/livetv/1002_20100604074022.mpg[]:[]0[]:[]0[]:[]1275623700[]:[]1275630300[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1275630022[]:[]1275630300[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]11825298[]:[][]:[]1275623700[]:[]0.200000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]2001

Command parameters:

1. int
   encoder id

Request parameters:

1. string GET_CURRENT_RECORDING

Response parameters:

1. progInfo
   recording (see here for all properties)

Since:

19

See Also:

IRemoteEncoder.getCurrentRecording(), Constant Field Values

MythTV protocol range: [19,-1)

	Version	Date	Additional Version Info
Added	19	2005-10-09	Changelog, SVN-Rev.: 7427
Removed	-1

QUERY_REMOTEENCODER_GET_FREE_INPUTS

static final String QUERY_REMOTEENCODER_GET_FREE_INPUTS

Query connected inputs.

This command returns the recorders connected inputs.

MythTV protocol example:
Example for an encoder with a free input:
41	QUERY_REMOTEENCODER 1[]:[]GET_FREE_INPUTS
31	MPEG2TS[]:[]1[]:[]1[]:[]1[]:[]0
Protocol version 74 example:
41	QUERY_REMOTEENCODER 4[]:[]GET_FREE_INPUTS
38	DVBInput[]:[]2[]:[]4[]:[]4[]:[]0[]:[]4
Example for an encoder with no free input:
41	QUERY_REMOTEENCODER 1[]:[]GET_FREE_INPUTS
10	EMPTY_LIST

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_FREE_INPUTS

Response parameters:

On error:

1. string
   EMPTY_LIST

On success - A List of:

1. string
   input name
2. int
   source id
3. int
   input id
4. int
   card id
5. int
   multiplex id
6. int
   live-tv order
   since 71

Since:

37

See Also:

IRemoteEncoder.getFreeInputs(), IFreeInputList, Constant Field Values

MythTV protocol range: [37,-1)

	Version	Date	Additional Version Info
Added	37	2008-01-14	Changelog, SVN-Rev.: 15437
Changed	71	2012-01-15	Changelog
Removed	-1

QUERY_REMOTEENCODER_GET_SLEEPSTATUS

static final String QUERY_REMOTEENCODER_GET_SLEEPSTATUS

Queries sleep status.

This command returns the current Sleep Status of the encoder.

MythTV protocol example:
41	QUERY_REMOTEENCODER 1[]:[]GET_SLEEPSTATUS
1	8

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_SLEEPSTATUS

Response parameters:

1. int
   sleep status

Since:

45

See Also:

SVN Rev. 20084, IRemoteEncoder.getSleepStatus(), ISleepStatus, Constant Field Values

MythTV protocol range: [45,-1)

	Version	Date	Additional Version Info
Added	45	2009-05-09	Changelog, SVN-Rev.: 20523
Removed	-1

QUERY_REMOTEENCODER_GET_RECORDING_STATUS

static final String QUERY_REMOTEENCODER_GET_RECORDING_STATUS

Query encoder status.

This command gets the current recording status of the tuner.

MythTV protocol example:
For a recording encoder:
46	QUERY_REMOTEENCODER 1[]:[]GET_RECORDING_STATUS
2	-2
For a tuning encoder:
46	QUERY_REMOTEENCODER 3[]:[]GET_RECORDING_STATUS
3	-10

Command parameters:

1. int
   encoder id

Request parameters:

1. string
   GET_RECORDING_STATUS

Response parameters:

1. int
   recording status (see IProgramRecordingStatus.Status for all possible values)

Since:

63

See Also:

IRemoteEncoder.getRecordingStatus(), IProgramRecordingStatus, Constant Field Values

MythTV protocol range: [63,-1)

	Version	Date	Additional Version Info
Added	63	2010-09-25	Changelog, MythBuntu-Release: 11.04, MythTV-Release: 0.24, SVN-Rev.: 26518
Removed	-1

QUERY_RECORDER_IS_RECORDING

static final String QUERY_RECORDER_IS_RECORDING

Query busy status.

This command queries if the recorder is actually recording.

MythTV protocol example:
On a busy recorder:
33	QUERY_RECORDER 1[]:[]IS_RECORDING
1	1
On an idle recorder:
33	QUERY_RECORDER 3[]:[]IS_RECORDING
1	0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   IS_RECORDING

Response parameters:

1. int
   1=busy, 0=idle

Since:

00

See Also:

IRecorder.isRecording(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_GET_FRAMERATE

static final String QUERY_RECORDER_GET_FRAMERATE

Queries frame rate.

This command queries the recording frame rate.

MythTV protocol example:
If the recorder is recording:
34	QUERY_RECORDER 1[]:[]GET_FRAMERATE
2	25
If the recorder is NOT recording:
34	QUERY_RECORDER 1[]:[]GET_FRAMERATE
2	-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_FRAMERATE

Response parameters:

1. float
   framerate (-1 if not recording)

Since:

00

See Also:

IRecorder.getFrameRate(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_GET_FRAMES_WRITTEN

static final String QUERY_RECORDER_GET_FRAMES_WRITTEN

Queries written frames.

This command queries the number of frames written to disk.

MythTV protocol example:
Protocol version 65 example:
39	QUERY_RECORDER 1[]:[]GET_FRAMES_WRITTEN
9	0[]:[]153
Protocol version 66 example:
39	QUERY_RECORDER 1[]:[]GET_FRAMES_WRITTEN
3	153

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_FRAMES_WRITTEN

Response parameters:

1. int,int
   freespace
   deprecated 66
2. long
   freespace
   since 66

Since:

00

See Also:

IRecorder.getFramesWritten(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_RECORDER_GET_FILE_POSITION

static final String QUERY_RECORDER_GET_FILE_POSITION

Queries written bytes.

This command queries the total number of bytes written by the recorder.

MythTV protocol example:
Protocol version 66 example:
38	QUERY_RECORDER 1[]:[]GET_FILE_POSITION
7	8217352
Protocol version 65 example:
38	QUERY_RECORDER 1[]:[]GET_FILE_POSITION
13	0[]:[]8217352
Protocol version 65 example - If the recorder is NOT recording:
38	QUERY_RECORDER 1[]:[]GET_FILE_POSITION
9	-1[]:[]-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_FILE_POSITION

Response parameters:

1. int,int
   filePosition (-1, -1 if not recording
   deprecated 66)
2. long
   filePosition (-1 if not recording
   since 66)

Since:

00

See Also:

IRecorder.getFilePosition(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_RECORDER_GET_FREE_SPACE

static final String QUERY_RECORDER_GET_FREE_SPACE

Deprecated. 20

Queries bytes available to read.

This command ask the recorder for the number of bytes beyond "totalreadpos" it is safe to read.
This command may return a negative number, including -1 if the call succeeds. This means totalreadpos is past the "safe read" portion of the file.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_FREE_SPACE
2. long,long
   totalReadPos

Response parameters:

1. long,long
   bytes ready to read

Since:

00

See Also:

Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

QUERY_RECORDER_GET_MAX_BITRATE

static final String QUERY_RECORDER_GET_MAX_BITRATE

Queries maximum bitrage.

This command gets the maximum bitrate a recorder/encoder can output.

MythTV protocol example:
Protocol version 65 example:
36	QUERY_RECORDER 1[]:[]GET_MAX_BITRATE
14	0[]:[]10080000
Protocol version 66 example:
36	QUERY_RECORDER 1[]:[]GET_MAX_BITRATE
8	10080000

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_MAX_BITRATE

Response parameters:

1. int,int
   maxBitRate
   deprecated 66
2. long
   maxBitRate
   since 66

Since:

17

See Also:

IRecorder.getMaxBitrate(), Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_RECORDER_GET_CURRENT_RECORDING

static final String QUERY_RECORDER_GET_CURRENT_RECORDING

Queries current recording.

This command returns the recorders current recording.
This command was introduced to "find out if the slave backend is recording something the master backend thinks should be done by now.".

MythTV protocol example:
42	QUERY_RECORDER 1[]:[]GET_CURRENT_RECORDING
639	Schlimmer geht's immer[]:[][]:[]Als Ganove Kevin das Haus von Mr. Fairbanks ausräumen will, wird er von ihm ertappt und der Polizei übergeben. Zuvor nimmt Fairbanks ihm noch dessen Ring ab. Der bestohlene Dieb sinnt auf Rache...[]:[]spielfilm[]:[]1002[]:[]1[]:[]ATV+[]:[]ATV+[]:[]/var/lib/mythtv/livetv/1002_20100604074022.mpg[]:[]0[]:[]0[]:[]1275623700[]:[]1275630300[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1275630022[]:[]1275630300[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]11825298[]:[][]:[]1275623700[]:[]0.200000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]2001

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_CURRENT_RECORDING

Response parameters:

1. progInfo
   recording (see here for all properties)

Since:

19

See Also:

IRecorder.getCurrentRecording(), Constant Field Values

MythTV protocol range: [19,-1)

	Version	Date	Additional Version Info
Added	19	2005-10-09	Changelog, SVN-Rev.: 7427
Removed	-1

QUERY_RECORDER_GET_KEYFRAME_POS

static final String QUERY_RECORDER_GET_KEYFRAME_POS

Queries keyframe position.

This command ask a recorder to return byte position in RingBuffer of a keyframe.

If you need to query a continuous range of frame numbers, use FILL_POSITION_MAP instead.

MythTV protocol example:
On error:
50	QUERY_RECORDER 3[]:[]GET_KEYFRAME_POS[]:[]0[]:[]11
9	-1[]:[]-1
On success:
50	QUERY_RECORDER 3[]:[]GET_KEYFRAME_POS[]:[]0[]:[]13
12	0[]:[]380778

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_KEYFRAME_POS
2. int,int
   desired frame number
   deprecated 66
3. long
   desired frame number
   since 66

Response parameters:

1. int,int
   keyframe byte postion
   deprecated 66
2. long
   keyframe byte position
   since 66

Since:

00

See Also:

IRecorder.getKeyframePosition(long), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	66	2011-05-25	Changelog, Changelog
Removed	-1

QUERY_RECORDER_FILL_POSITION_MAP

static final String QUERY_RECORDER_FILL_POSITION_MAP

Queries keyframe position map.

Returns byte position in RingBuffer of a keyframes according to recorder.

Note:
For protocol versions prior to 43, only 32 bit integer values are supported as frame numbers.
If you need to work with larger numbers, use GET_KEYFRAME_POS instead.

MythTV protocol example:
Protocol Version 63 example:
52	QUERY_RECORDER 3[]:[]FILL_POSITION_MAP[]:[]0[]:[]201
305	12[]:[]380778[]:[]24[]:[]745322[]:[]36[]:[]1134442[]:[]48[]:[]1525674[]:[]60[]:[]1964906[]:[]72[]:[]2346922[]:[]84[]:[]2744234[]:[]96[]:[]3168106[]:[]108[]:[]3579818[]:[]120[]:[]4004714[]:[]132[]:[]4403114[]:[]144[]:[]4855658[]:[]156[]:[]5216170[]:[]168[]:[]5686122[]:[]180[]:[]6014890[]:[]192[]:[]6389610
Protocol Version < 63 example:
52	QUERY_RECORDER 1[]:[]FILL_POSITION_MAP[]:[]0[]:[]225
815	0[]:[]0[]:[]0[]:[]38[]:[]0[]:[]1[]:[]0[]:[]485414[]:[]0[]:[]2[]:[]0[]:[]780326[]:[]0[]:[]3[]:[]0[]:[]1071142[]:[]0[]:[]4[]:[]0[]:[]1345574[]:[]0[]:[]5[]:[]0[]:[]1630246[]:[]0[]:[]6[]:[]0[]:[]1910822[]:[]0[]:[]7[]:[]0[]:[]2189350[]:[]0[]:[]8[]:[]0[]:[]2465830[]:[]0[]:[]9[]:[]0[]:[]2758694[]:[]0[]:[]10[]:[]0[]:[]3067942[]:[]0[]:[]11[]:[]0[]:[]3366950[]:[]0[]:[]12[]:[]0[]:[]3674150[]:[]0[]:[]13[]:[]0[]:[]3981350[]:[]0[]:[]14[]:[]0[]:[]4290598[]:[]0[]:[]15[]:[]0[]:[]4589606[]:[]0[]:[]16[]:[]0[]:[]4876326[]:[]0[]:[]17[]:[]0[]:[]5165094[]:[]0[]:[]18[]:[]0[]:[]5453862[]:[]0[]:[]19[]:[]0[]:[]5744678[]:[]0[]:[]20[]:[]0[]:[]6041638[]:[]0[]:[]21[]:[]0[]:[]6332454[]:[]0[]:[]22[]:[]0[]:[]6623270[]:[]0[]:[]23[]:[]0[]:[]6912038[]:[]0[]:[]24[]:[]0[]:[]7198758[]:[]0[]:[]25[]:[]0[]:[]7487526[]:[]0[]:[]26[]:[]0[]:[]7772198

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   FILL_POSITION_MAP
2. int
   starting frame number
   deprecated 43
3. long
   starting frame number
   since 43
4. int
   ending frame number
   deprecated 43
5. long
   ending frame number
   since 43

Response parameters:

1. int,int
   keynum
   deprecated 43
2. long
   keynum
   since 43
3. int,int
   value
   deprecated 43
4. long
   value
   since 43

Since:

00

See Also:

IRecorder.fillPositionMap(long, long), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	43	2008-12-22	Changelog, SVN-Rev.: 19417
Removed	-1

QUERY_RECORDER_FILL_DURATION_MAP

static final String QUERY_RECORDER_FILL_DURATION_MAP

Queries the duration map of a recording.

Returns time position in RingBuffer of a keyframes according to recorder.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   FILL_DURATION_MAP
2. long
   starting frame number
3. long
   ending frame number

Response parameters:

1. long
   keynum
2. long
   time in seconds

Since:

77

See Also:

IRecorder.fillDurationMap(long, long), Constant Field Values

MythTV protocol range: [77,-1)

	Version	Date	Additional Version Info
Added	77	2013-01-01	Changelog, MythTV-Release: 0.26
Removed	-1

QUERY_RECORDER_SETUP_RING_BUFFER

static final String QUERY_RECORDER_SETUP_RING_BUFFER

Deprecated. 20

Setup a ring buffer.

This command sets up RingBuffer for "Live TV" playback.

MythTV protocol example:
44	QUERY_RECORDER 1[]:[]SETUP_RING_BUFFER[]:[]0
77	rbuf://127.0.0.1:6543/cache/cache/ringbuf1.nuv[]:[]1[]:[]0[]:[]0[]:[]52428800

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SETUP_RING_BUFFER
2. boolean
   1=picture in picture

Response parameters:

1. string
   ok | not_ok
2. string
   url to ringbuffer file
3. long,long
   filesize
4. long,long
   fillamount

Since:

00

See Also:

IRingBuffer, Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

QUERY_RECORDER_GET_RECORDING

static final String QUERY_RECORDER_GET_RECORDING

Query current recording.

MythTV protocol example:
34	QUERY_RECORDER 1[]:[]GET_RECORDING
639	Schlimmer geht's immer[]:[][]:[]Als Ganove Kevin das Haus von Mr. Fairbanks ausräumen will, wird er von ihm ertappt und der Polizei übergeben. Zuvor nimmt Fairbanks ihm noch dessen Ring ab. Der bestohlene Dieb sinnt auf Rache...[]:[]spielfilm[]:[]1002[]:[]1[]:[]ATV+[]:[]ATV+[]:[]/var/lib/mythtv/livetv/1002_20100604074022.mpg[]:[]0[]:[]0[]:[]1275623700[]:[]1275630300[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]1[]:[]0[]:[]0[]:[]-2[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1275630022[]:[]1275630300[]:[]0[]:[]4[]:[]LiveTV[]:[]0[]:[][]:[]11825298[]:[][]:[]1275623700[]:[]0.200000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]LiveTV[]:[]0[]:[]0[]:[]0[]:[]2001
If the recorder is not recording:
34	QUERY_RECORDER 1[]:[]GET_RECORDING
333	[]:[][]:[][]:[][]:[][]:[][]:[][]:[][]:[][]:[]0[]:[]0[]:[]1275631440[]:[]1275631440[]:[]0[]:[]0[]:[]0[]:[][]:[]0[]:[]1[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0[]:[]15[]:[]6[]:[]1275631440[]:[]1275631440[]:[]0[]:[]0[]:[]Default[]:[]0[]:[][]:[][]:[][]:[]1275631440[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]0[]:[]0[]:[]0[]:[]

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_RECORDING

Response parameters:

1. progInfo
   recording (see here for all properties)

Since:

00

See Also:

IRecorder.getRecording(), IProgramInfo, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_STOP_PLAYING

static final String QUERY_RECORDER_STOP_PLAYING

Deprecated. 20

Stop playing.

This command tells the recorder to stop streaming a recording to the frontend.
This command is used prior to 20 if watching a recording should be stopped.

Note
This command seems to be still available in remoteencoder.cpp but is accessible anymore in mainserver.cpp

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   STOP_PLAYING

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.stopPlaying(), Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

QUERY_RECORDER_FRONTEND_READY

static final String QUERY_RECORDER_FRONTEND_READY

Frontend ready.

This command tells the recorder that the frontend is up and ready.

This is required e.g. if the backend needs to transmit the ASK_RECORDING message to the frontend.

MythTV protocol example:
35	QUERY_RECORDER 1[]:[]FRONTEND_READY
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   FRONTEND_READY

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.signalFrontendReady(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_CANCEL_NEXT_RECORDING

static final String QUERY_RECORDER_CANCEL_NEXT_RECORDING

Cancel next recording.

this command tells the recorder to cancel the next recording.
This is used when the user is watching "Live TV" and does not want to allow the recorder to be taken for a pending recording.

MythTV protocol example:
Cancel next recording:
48	QUERY_RECORDER 1[]:[]CANCEL_NEXT_RECORDING[]:[]1
2	ok
Allow next recording:
48	QUERY_RECORDER 1[]:[]CANCEL_NEXT_RECORDING[]:[]0
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CANCEL_NEXT_RECORDING
2. boolean
   1=cancel, 0=continue
   since 23

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.cancelNextRecording(java.lang.Boolean), BACKEND_MESSAGE_ASK_RECORDING, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	23	2006-01-10	Changelog, SVN-Rev.: 8553
Removed	-1

QUERY_RECORDER_SPAWN_LIVETV

static final String QUERY_RECORDER_SPAWN_LIVETV

Spawn LiveTV.

This command tells the backend to spawn a "Live TV" recorder.

See SET_NEXT_LIVETV_DIR on how to change the recording directory to use.

MythTV protocol example:
Version 15:
33	QUERY_RECORDER 1[]:[]SPAWN_LIVETV
2	ok
Version 20:
79	QUERY_RECORDER 1[]:[]SPAWN_LIVETV[]:[]live-seans-laptop-07-03-23T12:30:32[]:[]0
2	ok
Version 56:
81	QUERY_RECORDER 1[]:[]SPAWN_LIVETV[]:[]live-seans-laptop-1302425076102[]:[]0[]:[]1
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SPAWN_LIVETV
2. string
   chain-id - the LiveTV chain id to use
   since 20
3. int pip
   Tells TVRec's RingBuffer that this is for a Picture in Picture display
   since 20
4. string
   startchan - the channel the LiveTV should start with
   since 34

Response parameters:

1. string
   ok

Since:

00

See Also:

SET_NEXT_LIVETV_DIR, IRecorder.spawnLiveTV(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	20	2005-11-05	Changelog, SVN-Rev.: 7739
Changed	34	2007-04-13	Changelog, SVN-Rev.: 13230
Removed	-1

QUERY_RECORDER_STOP_LIVETV

static final String QUERY_RECORDER_STOP_LIVETV

Stop LiveTV.

This command tells the backend to stop a "Live TV" recorder.

MythTV protocol example:
32	QUERY_RECORDER 1[]:[]STOP_LIVETV
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   STOP_LIVETV

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.stopLiveTv(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_PAUSE_RECORDER

static final String QUERY_RECORDER_PAUSE_RECORDER

Deprecated. 18, was supported just a very short time period, use QUERY_RECORDER_PAUSE instead.

Pause recorder.

This command tells the backend to pause a recorder.

This is used for channel and input changes.

This command was only available in 18, therefore we will not implement it.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   PAUSE_RECORDER

Response parameters:

1. string
   ok

Since:

18

See Also:

Constant Field Values

MythTV protocol range: [18,18)

	Version	Date	Additional Version Info
Added	18	2005-07-19	Changelog, SVN-Rev.: 6865
Removed	18	2005-07-19	Changelog, SVN-Rev.: 6865

QUERY_RECORDER_PAUSE

static final String QUERY_RECORDER_PAUSE

Pause recorder.

This command tells the backend to pause a recorder.

This is used for channel and input changes.

MythTV protocol example:
26	QUERY_RECORDER 1[]:[]PAUSE
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   PAUSE

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.pause(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_UNPAUSE

static final String QUERY_RECORDER_UNPAUSE

Deprecated. 18, was supported just a very short time period

Unpause recorder.

This command tells the backend to unpause a recorder.

This command was only available in 18, therefore we will not implement it.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   UNPAUSE

Response parameters:

1. string
   ok

Since:

18

See Also:

Constant Field Values

MythTV protocol range: [18,18)

	Version	Date	Additional Version Info
Added	18	2005-07-19	Changelog, SVN-Rev.: 6865
Removed	18	2005-07-19	Changelog, SVN-Rev.: 6865

QUERY_RECORDER_FINISH_RECORDING

static final String QUERY_RECORDER_FINISH_RECORDING

Finish recording.

This command tells a backend to stop recording, but only after "overrecord" seconds.

MythTV protocol example:
37	QUERY_RECORDER 1[]:[]FINISH_RECORDING
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   FINISH_RECORDING

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.finishRecording(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_SET_LIVE_RECORDING

static final String QUERY_RECORDER_SET_LIVE_RECORDING

Keep LiveTV recording.

This command tells the backend to keep a LiveTV recording, if "recording" is 1.

MythTV protocol example:
46	QUERY_RECORDER 1[]:[]SET_LIVE_RECORDING[]:[]-1
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SET_LIVE_RECORDING
2. int
   -1 (currently only -1 is supported)

Response parameters:

1. string
   ok

Since:

26

See Also:

IRecorder.setLiveTvRecording(), Constant Field Values

MythTV protocol range: [26,-1)

	Version	Date	Additional Version Info
Added	26	2006-01-17	Changelog, MythTV-Release: 0.19, SVN-Rev.: 8754
Removed	-1

QUERY_RECORDER_TOGGLE_INPUTS

static final String QUERY_RECORDER_TOGGLE_INPUTS

Deprecated. 27, replaced by QUERY_RECORDER_GET_CONNECTED_INPUTS, QUERY_RECORDER_GET_INPUT and QUERY_RECORDER_SET_INPUT

Change to next input.

This command tells are recorder to change to the next input.

MythTV protocol example:
34	QUERY_RECORDER 1[]:[]TOGGLE_INPUTS
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   TOGGLE_INPUTS

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.toggleInputs(), Constant Field Values

MythTV protocol range: [00,27)

	Version	Date	Additional Version Info
Added	00
Removed	27	2006-02-15	Changelog, SVN-Rev.: 8973

QUERY_RECORDER_GET_CONNECTED_INPUTS

static final String QUERY_RECORDER_GET_CONNECTED_INPUTS

Deprecated. 37, replaced by QUERY_RECORDER_GET_FREE_INPUTS

Get connected inputs.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_CONNECTED_INPUTS

Response parameters:

On success:

1. string[]
   input name

On error:

1. string
   EMPTY_LIST

Since:

27

See Also:

IRecorder.getConnectedInputs(), Constant Field Values

MythTV protocol range: [27,37)

	Version	Date	Additional Version Info
Added	27	2006-02-15	Changelog, SVN-Rev.: 8973
Removed	37	2008-01-14	Changelog, SVN-Rev.: 15437

QUERY_RECORDER_GET_FREE_INPUTS

static final String QUERY_RECORDER_GET_FREE_INPUTS

Get free inputs.

This command tells a recorder to return all free inputs.

MythTV protocol example:
36	QUERY_RECORDER 1[]:[]GET_FREE_INPUTS
31	MPEG2TS[]:[]1[]:[]1[]:[]1[]:[]0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_FREE_INPUTS
2. int[]
   list of card-IDs to exclude (optional)

Response parameters:

1. string
   input name
2. int
   source id
3. int
   input id
4. int
   card id
5. int
   multiplex id

Since:

37

See Also:

IRecorder.getFreeInputs(), IFreeInputList, Constant Field Values

MythTV protocol range: [37,-1)

	Version	Date	Additional Version Info
Added	37	2008-01-14	Changelog, SVN-Rev.: 15437
Removed	-1

QUERY_RECORDER_GET_INPUT

static final String QUERY_RECORDER_GET_INPUT

Query used input.

This command returns the recorders current input.

MythTV protocol example:
Example for an Hauppauge PVR-350 card:
30	QUERY_RECORDER 1[]:[]GET_INPUT
7	MPEG2TS
Example for an Haupppauge DVB-T card:
30	QUERY_RECORDER 1[]:[]GET_INPUT
8	DVBInput
Example for an inactive Recorder:
30	QUERY_RECORDER 1[]:[]GET_INPUT
7	UNKNOWN

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_INPUT

Response parameters:

1. string
   input name (UNKNOWN if unknown)

Since:

27

See Also:

IRecorder.getInput(), Constant Field Values

MythTV protocol range: [27,-1)

	Version	Date	Additional Version Info
Added	27	2006-02-15	Changelog, SVN-Rev.: 8973
Removed	-1

QUERY_RECORDER_SET_INPUT

static final String QUERY_RECORDER_SET_INPUT

Change input.

This command tells the recorder to change to the specified input.

ATTENTION: You must pause the recorder before doing this.

A list of available inputs can be queried using QUERY_RECORDER_GET_CONNECTED_INPUTS or QUERY_RECORDER_GET_FREE_INPUTS.

MythTV protocol example:
Switch to a named input:
43	QUERY_RECORDER 1[]:[]SET_INPUT[]:[]DVBInput
8	DVBInput
Switch to the next input:
52	QUERY_RECORDER 1[]:[]SET_INPUT[]:[]SwitchToNextInput
8	DVBInput

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SET_INPUT
2. string
   input-name | SwitchToNextInput

Response parameters:

1. string
   input name (UNKNOWN if unknown)

Since:

27

See Also:

IRecorder.setInput(String), IRecorder.switchToNextInput(), Constant Field Values

MythTV protocol range: [27,-1)

	Version	Date	Additional Version Info
Added	27	2006-02-15	Changelog, SVN-Rev.: 8973
Removed	-1

QUERY_RECORDER_TOGGLE_CHANNEL_FAVORITE

static final String QUERY_RECORDER_TOGGLE_CHANNEL_FAVORITE

Toggle channel favorite.

This command toggles whether the current channel should be on our favorites list.

MythTV protocol example:
58	QUERY_RECORDER 1[]:[]TOGGLE_CHANNEL_FAVORITE[]:[]Favorites
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   TOGGLE_CHANNEL_FAVORITE
2. String
   changroup
   since 45

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.toggleChannelFavorite(), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	45	2009-05-09	Changelog, SVN-Rev.: 20523
Removed	-1

QUERY_RECORDER_CHANGE_CHANNEL

static final String QUERY_RECORDER_CHANGE_CHANNEL

Change channel.

This command forces the recorder to change to the next or previous channel.
ATTENTION: You must pause the recorder before doing this.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHANGE_CHANNEL
2. int
   direction

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.changeChannel(org.jmythapi.protocol.request.EChannelChangeDirection), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_SET_CHANNEL

static final String QUERY_RECORDER_SET_CHANNEL

Set Channel.

This command forces the recorder to change to the named channel on the current tuner.
ATTENTION: You must pause the recorder before doing this.

MythTV protocol example:
38	QUERY_RECORDER 1[]:[]SET_CHANNEL[]:[]3
2	ok

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SET_CHANNEL
2. string
   channel number

Response parameters:

1. string
   ok

Since:

00

See Also:

IRecorder.setChannel(String), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_SET_SIGNAL_MONITORING_RATE

static final String QUERY_RECORDER_SET_SIGNAL_MONITORING_RATE

Sets the signal monitoring rate.

This is only be used to toggle signal monitoring once you are already watching a recording.

MythTV protocol example:
60	QUERY_RECORDER 1[]:[]SET_SIGNAL_MONITORING_RATE[]:[]-1[]:[]0
1	0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SET_SIGNAL_MONITORING_RATE
2. int
   rate (Milliseconds between each signal check, 0 to disable, -1 to preserve old value.)
3. int
   notifyFrontend (If 1 SIGNAL messages are sent to the frontend, if 0 SIGNAL messages will not be sent, and if -1 the old value is preserved.)

Response parameters:

1. int
   old rate

Since:

18

See Also:

IRecorder.setSignalMonitoringRate(int, boolean), Constant Field Values

MythTV protocol range: [18,-1)

	Version	Date	Additional Version Info
Added	18	2005-07-19	Changelog, SVN-Rev.: 6865
Removed	-1

QUERY_RECORDER_GET_COLOUR

static final String QUERY_RECORDER_GET_COLOUR

Get colour.

Gets the colour of a recording.

MythTV protocol example:
31	QUERY_RECORDER 1[]:[]GET_COLOUR
2	50
On Error:
31	QUERY_RECORDER 1[]:[]GET_COLOUR
2	-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_COLOUR

Response parameters:

1. int
   color (-1 on error)

Since:

30

See Also:

IRecorder.getColour(), Constant Field Values

MythTV protocol range: [30,-1)

	Version	Date	Additional Version Info
Added	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_GET_CONTRAST

static final String QUERY_RECORDER_GET_CONTRAST

Get contrast.

Gets the contrast of a recording.

MythTV protocol example:
33	QUERY_RECORDER 1[]:[]GET_CONTRAST
2	50
On Error:
33	QUERY_RECORDER 1[]:[]GET_CONTRAST
2	-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_CONTRAST

Response parameters:

1. int
   contrast (-1 on error)

Since:

30

See Also:

IRecorder.getContrast(), Constant Field Values

MythTV protocol range: [30,-1)

	Version	Date	Additional Version Info
Added	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_GET_BRIGHTNESS

static final String QUERY_RECORDER_GET_BRIGHTNESS

Get Brightness.

Gets the brightness of a recording.

MythTV protocol example:
35	QUERY_RECORDER 1[]:[]GET_BRIGHTNESS
2	50
On Error:
35	QUERY_RECORDER 1[]:[]GET_BRIGHTNESS
2	-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_BRIGHTNESS

Response parameters:

1. int
   brightness (-1 on error)

Since:

30

See Also:

IRecorder.getBrightness(), Constant Field Values

MythTV protocol range: [30,-1)

	Version	Date	Additional Version Info
Added	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_GET_HUE

static final String QUERY_RECORDER_GET_HUE

Get hue.

Gets the hue of a recording.

MythTV protocol example:
28	QUERY_RECORDER 1[]:[]GET_HUE
2	50
On Error:
28	QUERY_RECORDER 1[]:[]GET_HUE
2	-1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_HUE

Response parameters:

1. int
   hue (-1 on error)

Since:

30

See Also:

IRecorder.getHue(), Constant Field Values

MythTV protocol range: [30,-1)

	Version	Date	Additional Version Info
Added	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_CHANGE_COLOUR

static final String QUERY_RECORDER_CHANGE_COLOUR

Change colour.

Changes the colour of a recording.
Note: In practice this only works with frame grabbing recorders.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHANGE_COLOUR
2. int
   type
   since 30
3. bool
   1=up, 0=down

Response parameters:

1. int
   color (-1 on error)

Since:

00

See Also:

IRecorder.changeColour(EPictureAdjustmentType, boolean), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_CHANGE_CONTRAST

static final String QUERY_RECORDER_CHANGE_CONTRAST

Changes contrast.

Changes the contrast of a recording.
Note: In practice this only works with frame grabbing recorders.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHANGE_CONTRAST
2. int
   type
   since 30
3. bool
   1=up, 0=down

Response parameters:

1. int
   : contrast (-1 on error)

Since:

00

See Also:

IRecorder.changeContrast(EPictureAdjustmentType, boolean), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_CHANGE_BRIGHTNESS

static final String QUERY_RECORDER_CHANGE_BRIGHTNESS

Changes brightness.

Changes the brightness of a recording.
Note: In practice this only works with frame grabbing recorders.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHANGE_BRIGHTNESS
2. int
   type
   since 30
3. bool
   1=up, 0=down

Response parameters:

1. int
   brightness (-1 on error)

Since:

00

See Also:

IRecorder.changeBrightness(EPictureAdjustmentType, boolean), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_CHANGE_HUE

static final String QUERY_RECORDER_CHANGE_HUE

Changes hue.

Changes the hue of a recording.
Note: In practice this only works with frame grabbing recorders.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHANGE_HUE
2. int
   type
   since 30
3. bool
   1=up, 0=down

Response parameters:

1. int
   hue (-1 on error)

Since:

00

See Also:

IRecorder.changeHue(EPictureAdjustmentType, boolean), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	30	2006-05-22	Changelog, MythTV-Release: 0.20, SVN-Rev.: 9968
Removed	-1

QUERY_RECORDER_CHECK_CHANNEL

static final String QUERY_RECORDER_CHECK_CHANNEL

Check if channel exists on current.

This command checks if named channel exists on current tuner.
ATTENTION: You must pause the recorder before doing this.

MythTV protocol example:
44	QUERY_RECORDER 1[]:[]CHECK_CHANNEL[]:[]10123
1	1

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHECK_CHANNEL
2. string
   channel number

Response parameters:

1. boolean
   1=channel available

Since:

00

See Also:

IRecorder.checkChannel(String), Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

QUERY_RECORDER_SHOULD_SWITCH_CARD

static final String QUERY_RECORDER_SHOULD_SWITCH_CARD

Check if channel exists on other recorder.

This command checks if named channel exists on current tuner, or another tuner.

MythTV protocol example:
49	QUERY_RECORDER 1[]:[]SHOULD_SWITCH_CARD[]:[]11123
1	0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SHOULD_SWITCH_CARD
2. string
   channel number

Response parameters:

1. boolean
   0=switch not required

Since:

17

See Also:

IRecorder.shouldSwitchCard(Integer), Constant Field Values

MythTV protocol range: [17,-1)

	Version	Date	Additional Version Info
Added	17	2005-05-24	Changelog, SVN-Rev.: 6482
Removed	-1

QUERY_RECORDER_CHECK_CHANNEL_PREFIX

static final String QUERY_RECORDER_CHECK_CHANNEL_PREFIX

Check channel prefix.

Checks a channel-number prefix against the channels in the MythTV-DB.

MythTV protocol example:
Example for unknown prefix:
47	QUERY_RECORDER 1[]:[]CHECK_CHANNEL_PREFIX[]:[]3
19	0[]:[]0[]:[]0[]:[]X
Example for known prefix:
50	QUERY_RECORDER 1[]:[]CHECK_CHANNEL_PREFIX[]:[]1012
19	1[]:[]0[]:[]1[]:[]X
Example for full matching channel number:
51	QUERY_RECORDER 1[]:[]CHECK_CHANNEL_PREFIX[]:[]10123
19	1[]:[]1[]:[]0[]:[]X

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   CHECK_CHANNEL_PREFIX
2. string
   channel number prefix

Response parameters:

1. int
   match
2. int
   unique
3. int
   extra_char_useful
   since 24
4. string
   needed_spacer
   since 24

Since:

00

See Also:

IRecorder.checkChannelPrefix(String), IRecorderChannelPrefixStatus, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	24	2006-01-15	Changelog, SVN-Rev.: 8617
Removed	-1

QUERY_RECORDER_GET_NEXT_PROGRAM_INFO

static final String QUERY_RECORDER_GET_NEXT_PROGRAM_INFO

Query program info.

Command to query informations about a channel program.
This command returns information about the program that would be seen if we changed the channel using ChangeChannel(int) with "direction".

MythTV protocol example:
85	QUERY_RECORDER 1[]:[]GET_NEXT_PROGRAM_INFO[]:[]2[]:[]18[]:[]1[]:[]2008-02-07T07:20:47
203	Sabrina - Total verhext![]:[]Die Verjüngungskur[]:[] []:[]Comedyserie[]:[]2008-02-07T07:00:00[]:[]2008-02-07T07:25:00[]:[]PRO7[]:[]/home/mythtv/.mythtv/channels/pro7.gif[]:[]3[]:[]19[]:[]193741841[]:[]

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_NEXT_PROGRAM_INFO
2. string
   channel number
3. string
   chanid
4. int
   direction
5. date
   starttime

Response parameters:

1. string
   title
2. string
   subtitle
3. string
   desc
4. string
   category
5. date
   starttime
6. date
   endtime
7. string
   channel sign
8. string
   channel icon
9. string
   channel number
10. int
    channel id
11. int
    series id
    since 08
12. int
    program id
    since 08

Since:

00

See Also:

IRecorder.getNextProgramInfo(org.jmythapi.IBasicChannelInfo, org.jmythapi.protocol.request.EChannelBrowseDirection, java.util.Date), IRecorderNextProgramInfo, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	08	2004-05-09	Changelog, MythTV-Release: 0.15, SVN-Rev.: 3621
Removed	-1

QUERY_RECORDER_GET_PROGRAM_INFO

static final String QUERY_RECORDER_GET_PROGRAM_INFO

Deprecated. 21, use QUERY_RECORDER_GET_RECORDING or QUERY_RECORDER_GET_NEXT_PROGRAM_INFO instead.

Query current program.

Gets the current program on the current recorder channel.
ATTENTION: This does not return a full programInfo, instead only a subset of the programInfo fields are returned.

MythTV protocol example:
Example on a busy recorder:
37	QUERY_RECORDER 1[]:[]GET_PROGRAM_INFO
221	Unter uns[]:[]Folge 3274[]:[] []:[]Familienserie[]:[]2008-02-07T08:00:00[]:[]2008-02-07T08:30:00[]:[]RTL[]:[]/home/mythtv/.mythtv/channels/rtl.gif[]:[]4[]:[]20[]:[]180627459[]:[] []:[] []:[]0[]:[]2008-02-07T08:00:00[]:[]0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_PROGRAM_INFO

Response parameters:

1. string
   title
2. string
   subtitle
3. string
   desc
4. string
   category
5. date
   starttime
6. date
   endtime
7. string
   channel sign
8. string
   channel icon path
9. string
   channel number
10. int
    channel id
11. int
    series id
    since 08
12. int
    program id
    since 08
13. string
    chanOutputFilters
    since 10
14. boolean
    repeat
    since 13
15. date
    airdate
    since 13
16. float
    stars
    since 13

Since:

00

See Also:

IRecorder.getProgramInfo(), IRecorderProgramInfo, Constant Field Values

MythTV protocol range: [00,21)

	Version	Date	Additional Version Info
Added	00
Changed	08	2004-05-09	Changelog, MythTV-Release: 0.15, SVN-Rev.: 3621
Changed	10	2004-07-01	Changelog, SVN-Rev.: 3966
Changed	13	2004-08-16	Changelog, SVN-Rev.: 4122
Removed	21	2005-11-10	Changelog, SVN-Rev.: 7826

QUERY_RECORDER_GET_INPUT_NAME

static final String QUERY_RECORDER_GET_INPUT_NAME

Deprecated. 21, use QUERY_RECORDER_GET_INPUT instead.

Query used input.

Command to query the name of the current input of a recorder.

MythTV protocol example:
35	QUERY_RECORDER 1[]:[]GET_INPUT_NAME
7	Tuner 0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_INPUT_NAME

Response parameters:

1. string
   input name

Since:

00

See Also:

IRecorder.getInputName(), Constant Field Values

MythTV protocol range: [00,21)

	Version	Date	Additional Version Info
Added	00
Removed	21	2005-11-10	Changelog, SVN-Rev.: 7826

QUERY_RECORDER_GET_CHANNEL_INFO

static final String QUERY_RECORDER_GET_CHANNEL_INFO

Query channel info.

Command to query informations about a channel.
This command allows the frontend to query a backend recorder for some additional information about the current channel (or another channel).

MythTV protocol example:
46	QUERY_RECORDER 1[]:[]GET_CHANNEL_INFO[]:[]1000
48	1000[]:[]1[]:[]ORF1[]:[]2[]:[]ORF 1[]:[]1.orf.at

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   GET_CHANNEL_INFO
2. int
   channel id

Response parameters:

1. int
   chan id
2. int
   source id
3. string
   channel sign
4. string
   channel number
5. string
   channel name
6. string
   xml tv id

Since:

28

See Also:

IRecorder.getChannelInfo(java.lang.Integer), IRecorderChannelInfo, Constant Field Values

MythTV protocol range: [28,-1)

	Version	Date	Additional Version Info
Added	28	2006-03-28	Changelog, SVN-Rev.: 9524
Removed	-1

QUERY_RECORDER_REQUEST_BLOCK_RINGBUF

static final String QUERY_RECORDER_REQUEST_BLOCK_RINGBUF

Deprecated. 20

Read ringbuffer block.

Command to read a data block from a ringbuffer.

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   REQUEST_BLOCK_RINGBUF
2. int
   block size

Response parameters:

1. int
   returned block size

Since:

00

See Also:

IRingBuffer.readBlock(byte[], int), Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

QUERY_RECORDER_SEEK_RINGBUF

static final String QUERY_RECORDER_SEEK_RINGBUF

Deprecated. 20

Seek in ringbuffer.

Command to seek within a ringbuffer.

MythTV protocol example:
63	QUERY_RECORDER 1[]:[]SEEK_RINGBUF[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0
7	0[]:[]0

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   SEEK_RINGBUF
2. long,long
   pos
3. int
   whence
4. long,long
   curpos

Response parameters:

1. long,long
   ret

Since:

00

See Also:

IRingBuffer.seek(long, long, org.jmythapi.protocol.response.ITransferable.Seek), Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

QUERY_RECORDER_DONE_RINGBUF

static final String QUERY_RECORDER_DONE_RINGBUF

Deprecated. 20

Destroy ringbuffer.

Informs a backend that a ringbuffer is not required anymore.

MythTV protocol example:
33	QUERY_RECORDER 1[]:[]DONE_RINGBUF
2	OK

Command parameters:

1. int
   recorder id

Request parameters:

1. string
   DONE_RINGBUF

Response parameters:

1. string
   OK

Since:

00

See Also:

IRingBuffer.done(), Constant Field Values

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

BACKEND_MESSAGE_DONE_RECORDING

static final String BACKEND_MESSAGE_DONE_RECORDING

Backend Message - Done Recording.

This message is sent by the backend to inform the client about a finished recording.

MythTV protocol example:
49	BACKEND_MESSAGE[]:[]DONE_RECORDING 1 84[]:[]empty

Message parameters:

1. string
   DONE_RECORDING
2. int
   recorder-id
3. int
   file length in seconds (frames-written / framerate)
   deprecated 45
4. int
   seconds since start
   since 45
5. int
   frames written
   since 45

Since:

00

See Also:

IDoneRecording, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	45	2009-05-09	Changelog, SVN-Rev.: 20523
Removed	-1

BACKEND_MESSAGE_UPDATE_FILE_SIZE

static final String BACKEND_MESSAGE_UPDATE_FILE_SIZE

Backend Message - Recording File Size changed.

This message is sent by the backend on changes to the recording-file size.

MythTV protocol example:
62	UPDATE_FILE_SIZE 1075 2012-01-19T22:20:00 3386394808[]:[]empty

Message parameters:

1. string
   UPDATE_FILE_SIZE
2. int
   channel-id
3. date
   recording-start-time
4. long
   file size

Since:

54

See Also:

IUpdateFileSize, Constant Field Values

MythTV protocol range: [54,-1)

	Version	Date	Additional Version Info
Added	54	2009-12-18	Changelog, SVN-Rev.: 22976
Removed	-1

BACKEND_MESSAGE_RECORDING_LIST_CHANGE

static final String BACKEND_MESSAGE_RECORDING_LIST_CHANGE

Backend Message - Recording List Changed.

This message is sent by the backend to inform the client about changes to a recording.
The following sub-types of this message are available:

• RECORDING_LIST_CHANGE for changes to the recording list.
• RECORDING_LIST_CHANGE DELETE for deleted recordings.
• RECORDING_LIST_CHANGE ADD for added recordings.
• RECORDING_LIST_CHANGE UPDATE for updated recordings.

Protocol Version Hint:

Starting with 52 this event was partially replaced by BACKEND_MESSAGE_UPDATE_PROG_INFO.
Starting with 55 BACKEND_MESSAGE_UPDATE_PROG_INFO was replaced by BACKEND_MESSAGE_RECORDING_LIST_CHANGE UPDATE.

MythTV protocol example:
51	BACKEND_MESSAGE[]:[]RECORDING_LIST_CHANGE[]:[]empty
On new recordings (since protocol version 53)
80	BACKEND_MESSAGE[]:[]RECORDING_LIST_CHANGE ADD 1073 2012-01-20T00:58:00[]:[]empty
On changed recordings (since protocol version 55; replaces UPDATE_PROG_INFO)
557	BACKEND_MESSAGE[]:[]RECORDING_LIST_CHANGE UPDATE[]:[]Scrubs - Die Anfänger[]:[]Mein Weg nach Hause[]:[]Manchmal ist es alles andere als einfach, nach Hause zu kommen...[]:[][]:[]1063[]:[]1[]:[]PRO7[]:[]Pro7[]:[]1063_20120116125500.mpg[]:[]0[]:[]2011492416[]:[]1326715201[]:[]1326716701[]:[]0[]:[]0[]:[]0[]:[]mythbox[]:[]0[]:[]0[]:[]0[]:[]0[]:[]-3[]:[]1925[]:[]0[]:[]15[]:[]6[]:[]1326714900[]:[]1326717300[]:[]0[]:[]516[]:[]Default[]:[]0[]:[][]:[]60697138[]:[][]:[]1327001290[]:[]0.000000[]:[][]:[]0[]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]2[]:[]0[]:[]0[]:[]
On deleted recordings (since protocol version 37, GIT 544ceb5584057581c699)
83	BACKEND_MESSAGE[]:[]RECORDING_LIST_CHANGE DELETE 1063 2012-01-16T12:55:00[]:[]empty

RECORDING_LIST_CHANGE Message (since 00)

Message parameters:

1. string
   RECORDING_LIST_CHANGE

RECORDING_LIST_CHANGE DELETE Message (since 37)

Message parameters:

1. string
   RECORDING_LIST_CHANGE
2. string
   DELETE
3. int
   the channel id of the deleted recording.
4. date
   the recording-start date of the deleted recording.

RECORDING_LIST_CHANGE ADD Message (since 53)

Message parameters:

1. string
   RECORDING_LIST_CHANGE
2. string
   ADD
3. int
   the channel id of the deleted recording.
4. date
   the recording-start date of the deleted recording.

RECORDING_LIST_CHANGE UPDATE Message (since 55)

Message parameters:

1. string
   RECORDING_LIST_CHANGE
2. string
   UPDATE
3. progInfo
   recording (see here for all properties)

Since:

00

See Also:

IRecordingListChangeSingle, IRecordingListChangeList, IRecordingListChangeAdd, IRecordingListChangeUpdate, IRecordingListChangeDelete, Constant Field Values

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Changed	37	2008-01-14	Changelog, SVN-Rev.: 15437
Changed	52	2009-11-30	Changelog, SVN-Rev.: 22932
Changed	53	2009-12-06	Changelog, SVN-Rev.: 22955
Changed	55	2009-12-21	Changelog, SVN-Rev.: 22992
Removed	-1

BACKEND_MESSAGE_UPDATE_PROG_INFO

static final String BACKEND_MESSAGE_UPDATE_PROG_INFO

Deprecated. 55, replaced by BACKEND_MESSAGE_RECORDING_LIST_CHANGE UPDATE.

Backend Message - Update Program Info.

This message tells the frontends to update a particular recording.
This is e.g. used for bookmark updates.

Protocol Version Hint:

This message partially replaces the message BACKEND_MESSAGE_RECORDING_LIST_CHANGE.

Message parameters:

1. string
   UPDATE_PROG_INFO
2. progInfo
   a recording (see here for all properties)

Since:

52

See Also:

IUpdateProgInfo, Constant Field Values

MythTV protocol range: [52,-1)

	Version	Date	Additional Version Info
Added	52	2009-11-30	Changelog, SVN-Rev.: 22932
Removed	-1

BACKEND_MESSAGE_MASTER_UPDATE_PROG_INFO

static final String BACKEND_MESSAGE_MASTER_UPDATE_PROG_INFO

Backend Message - Master Update Program Info.

This message is used to send program updates to the master backend first, so it can pull the updated recstatus before sending out UPDATE_PROG_INFO to the frontends.

Message parameters:

1. string
   MASTER_UPDATE_PROG_INFO
2. progInfo
   a recording (see here for all properties)

Since:

54

See Also:

Constant Field Values

BACKEND_MESSAGE_LIVETV_WATCH

static final String BACKEND_MESSAGE_LIVETV_WATCH

Backend Message - LiveTV Watch.

TODO: needs to be implemented.

Message parameters:

1. string
   LIVETV_WATCH
2. int
   card-id
3. int
   0 (fixed value; unknown purpose)

See Also:

Constant Field Values

BACKEND_MESSAGE_QUIT_LIVETV

static final String BACKEND_MESSAGE_QUIT_LIVETV

Backend Message - Quit LiveTV.

TODO: needs to be implemented.

See Also:

Constant Field Values

BACKEND_MESSAGE_LIVETV_CHAIN

static final String BACKEND_MESSAGE_LIVETV_CHAIN

Backend Message - LiveTV Chain Update.

This message is sent by the backend to inform the client abount live-tv chain updates.

MythTV protocol example:
85	BACKEND_MESSAGE[]:[]LIVETV_CHAIN UPDATE live-seans-laptop-07-03-23T12:30:32[]:[]empty

Since:

20

See Also:

ILiveTvChainUpdate, Constant Field Values

BACKEND_MESSAGE_ASK_RECORDING

static final String BACKEND_MESSAGE_ASK_RECORDING

Backend Message - Ask Recording.

This message is sent by the backend to ask for the permission to record a scheduled program.
The client can cancel the recording unsing CANCEL_NEXT_RECORDING.

MythTV protocol example:

439

BACKEND_MESSAGE[]:[]ASK_RECORDING 1 0 0 0[]:[]1 (TEST)[]:[]Thu Jun 7 11:33:00 2012[]:[][]:[]0[]:[]0[]:[][]:[]1000[]:[]1[]:[]TEST[]:[]Test[]:[]/var/lib/mythtv/recordings[]:[]0[]:[]1339061580[]:[]1339061880[]:[]0[]:[]mythbuntu1204[]:[]1[]:[]1[]:[]1[]:[]1[]:[]-1[]:[]19[]:[]1[]:[]15[]:[]6[]:[]1339061580[]:[]1339061880[]:[]0[]:[]Default[]:[][]:[][]:[][]:[][]:[]1339061593[]:[]0[]:[][]:[]Default[]:[]0[]:[]0[]:[]Default[]:[]0[]:[]0[]:[]0[]:[]0

Message parameters:

1. string
   ASK_RECORDING
2. int
   card-id
3. int
   seconds till recording
4. boolean
   has recording
   since 23
5. boolean
   has later showing
   since 37
6. progInfo
   a recording (see here for all properties)
   since 37

Since:

00

See Also:

IAskRecording, QUERY_REMOTEENCODER_CANCEL_NEXT_RECORDING, Constant Field Values

BACKEND_MESSAGE_SCHEDULE_CHANGE

static final String BACKEND_MESSAGE_SCHEDULE_CHANGE

Backend Message - Scheduler Changed.

This message is sent by the backend to inform the client about changes to the scheduled recordings list.

MythTV protocol example:
45	BACKEND_MESSAGE[]:[]SCHEDULE_CHANGE[]:[]empty

Message parameters:

1. string
   SCHEDULE_CHANGE

See Also:

IScheduleChange, Constant Field Values

BACKEND_MESSAGE_CLEAR_SETTINGS_CACHE

static final String BACKEND_MESSAGE_CLEAR_SETTINGS_CACHE

Backend Message - Clear Settings Cache.

A event forcing the backend to clear its settings cache.

This command should be used after changing any backend settings and forces the backend to reload settings from the database (for example, using MythWeb or Mythtv-setup).

MythTV protocol example:
50	BACKEND_MESSAGE[]:[]CLEAR_SETTINGS_CACHE[]:[]empty

Message parameters:

1. string
   CLEAR_SETTINGS_CACHE

Since:

23

See Also:

IClearSettingsCache, IBackend.clearSettingsCache(), Constant Field Values

MythTV protocol range: [23,-1)

	Version	Date	Additional Version Info
Added	23	2006-01-10	Changelog, SVN-Rev.: 8553
Removed	-1

BACKEND_MESSAGE_RESET_IDLETIME

static final String BACKEND_MESSAGE_RESET_IDLETIME

Backend Message - Reset Idletime.

Whenever mythshutdown --unlock is called send a message to the master BE telling it to restart the idle count down.

MythTV protocol example:
44	BACKEND_MESSAGE[]:[]RESET_IDLETIME[]:[]empty

Message parameters:

1. string
   RESET_IDLETIME

Since:

40

See Also:

IResetIdleTime, Constant Field Values

MythTV protocol range: [40,-1)

	Version	Date	Additional Version Info
Added	40	2008-02-17	Changelog, SVN-Rev.: 16090
Removed	-1

BACKEND_MESSAGE_SYSTEM_EVENT

static final String BACKEND_MESSAGE_SYSTEM_EVENT

Backend Message - System Event.

MythTV protocol example:
A newly connected client:
99	BACKEND_MESSAGE[]:[]SYSTEM_EVENT CLIENT_CONNECTED HOSTNAME mythbuntu11 SENDER mythbuntu11[]:[]empty
A recently disconnected client:
102	BACKEND_MESSAGE[]:[]SYSTEM_EVENT CLIENT_DISCONNECTED HOSTNAME mythbuntu11 SENDER mythbuntu11[]:[]empty
A scheduler event:
75	BACKEND_MESSAGE[]:[]SYSTEM_EVENT SCHEDULER_RAN SENDER mythbuntu11[]:[]empty

Message parameters:

1. string
   SYSTEM_EVENT
2. string
   name of the system event
3. string[]
   a list of key/value pairs.

See Also:

ISystemEvent, Constant Field Values

BACKEND_MESSAGE_COMMFLAG_START

static final String BACKEND_MESSAGE_COMMFLAG_START

Backend Message - Commflag Start.

TODO:

See Also:

ICommflagStart, Constant Field Values

BACKEND_MESSAGE_SHUTDOWN_COUNTDOWN

static final String BACKEND_MESSAGE_SHUTDOWN_COUNTDOWN

Backend Message - Backend is idle and waiting for shutdown.

The backend informs that only xx secs are left to system shutdown.

MythTV protocol example:
On Countdown reset:
51	BACKEND_MESSAGE[]:[]SHUTDOWN_COUNTDOWN -1[]:[]empty

Message parameters:

1. string
   SHUTDOWN_COUNTDOWN
2. int
   idle timeout seconts (-1 if shutdown countdown is aborted)

See Also:

IShutdownCountdown, Constant Field Values

BACKEND_MESSAGE_SHUTDOWN_NOW

static final String BACKEND_MESSAGE_SHUTDOWN_NOW

Backend Message - Backend will shutdown now.

The backend informs connected clients that the master server is going down now.

MythTV protocol example:
On Countdown reset:
42	BACKEND_MESSAGE[]:[]SHUTDOWN_NOW[]:[]empty

Message parameters:

1. string
   SHUTDOWN_NOW

See Also:

Constant Field Values

BACKEND_MESSAGE_SIGNAL

static final String BACKEND_MESSAGE_SIGNAL

Backend Message - Signal.

TODO:

Message parameters:

1. string
   SIGNAL
2. int
   card-id
3. string
   message text

See Also:

Constant Field Values

BACKEND_MESSAGE_DOWNLOAD_FILE

static final String BACKEND_MESSAGE_DOWNLOAD_FILE

Backend Message - Download File.

This message informs the frontend about a currently running backend download.
See DOWNLOAD_FILE on how to start a now download job.

The following sub-types of this message are available:

• DOWNLOAD_FILE UPDATE on status updates
• DOWNLOAD_FILE FINISHED on finished downloads

MythTV protocol example:
Download in progress
173	BACKEND_MESSAGE[]:[]DOWNLOAD_FILE UPDATE[]:[]http://upload.wikimedia.org/wikipedia/de/7/7c/ORF-Logo.svg[]:[]myth://Default@192.168.10.208:6543/ORF-Logo.svg[]:[]1024[]:[]6663
Download finished
90 B	ACKEND_MESSAGE[]:[]DOWNLOAD_FILE FINISHED[]:[]http://upload.wikimedia.org/wikipedia/de/7/7c/ORF-Logo.svg[]:[]myth://Default@192.168.10.208:6543/ORF-Logo.svg[]:[]6663[]:[]Unknown error[]:[]0

UPDATE Message

Message parameters:

1. string
   DOWNLOAD_FILE
2. string
   info type (UPDATE)
3. string
   the remote file URI
4. string
   the local file URI
5. int
   amount of downloaded bytes
6. int
   total file size in bytes

FINISHED Message

Message parameters:

1. string
   DOWNLOAD_FILE
2. string
   info type (FINISHED)
3. string
   the remote file URI
4. string
   the local file URI
5. int
   total file size in bytes
6. string
   error text (Unknown error on no error})
7. int
   error code (0 on no error})

Since:

58

See Also:

IDownloadFile, IDownloadFileUpdate, IDownloadFileFinished, IBackend.downloadFile(java.net.URI, String, String), Constant Field Values

BACKEND_MESSAGE_VIDEO_LIST_CHANGE

static final String BACKEND_MESSAGE_VIDEO_LIST_CHANGE

Backend Message - Video List - Change.

This event is sent by the backend at the end of a rescan of the video-storagegroup, if changes were found.
Since protocol 63 a list of changes is contained in the event.
If no changes were found, the BACKEND_MESSAGE_VIDEO_LIST_NO_CHANGE event is sent.

See SCAN_VIDEOS on how to trigger a rescan of the video storagegroup.

MythTV protocol example:
82	BACKEND_MESSAGE[]:[]VIDEO_LIST_CHANGE[]:[]deleted::4[]:[]deleted::5[]:[]deleted::6

Message parameters:

1. string
   VIDEO_LIST_CHANGE
2. list
   list of detected changes (possible values: deleted, added or moved)
   since 68

Since:

63

See Also:

IBackend.scanVideos(), IVideoListChange, Constant Field Values

BACKEND_MESSAGE_VIDEO_LIST_NO_CHANGE

static final String BACKEND_MESSAGE_VIDEO_LIST_NO_CHANGE

Backend Message - Video List - No Change.

This event is sent by the backend at the end of a rescan of the video-storagegroup, if no changes were found.
If changes were found to the storage group, the BACKEND_MESSAGE_VIDEO_LIST_CHANGE is sent instead.
See SCAN_VIDEOS on how to trigger a rescan of the video storagegroup.

MythTV protocol example:
50	BACKEND_MESSAGE[]:[]VIDEO_LIST_NO_CHANGE[]:[]empty

Message parameters:

1. string
   VIDEO_LIST_NO_CHANGE

Since:

69

See Also:

IBackend.scanVideos(), IVideoListNoChange, Constant Field Values

BACKEND_MESSAGE_GENERATED_PIXMAP

static final String BACKEND_MESSAGE_GENERATED_PIXMAP

Backend Message - Pixmap generated.

This event is sent by the backend as a result of the QUERY_GENPIXMAP2 command.
See QUERY_GENPIXMAP2 on how to query pixmap generation.

There following sub-types of this event are available:

• GENERATED_PIXMAP[]:[]OK on success.
• GENERATED_PIXMAP[]:[]ERROR on errors.

MythTV protocol example:
On Success:
129638	BACKEND_MESSAGE[]:[]GENERATED_PIXMAP[]:[]OK[]:[]1000_2012-05-20T11:28:00[]:[]On Disk[]:[]2012-05-29T06:57:26[]:[]97120[]:[]42534[]:[]iVBOR...ZQAAAABJRU5ErkJggg==[]:[]TEST
On Error:
113	BACKEND_MESSAGE[]:[]GENERATED_PIXMAP[]:[]ERROR[]:[]1000_2012-05-20T11:28:00[]:[]Pixmap generation failed[]:[]TEST

OK Message

Message parameters:

1. string
   GENERATED_PIXMAP
2. string
   info type (OK)
3. string
   unique recording id (containing the channel id and recording start date)
4. string
   status message
5. pixmap
   the pixmap data a recording (see here for all properties)
6. string
   token (the token that was specified by the client during the request).

ERROR Message

Message parameters:

1. string
   GENERATED_PIXMAP
2. string
   info type (ERROR)
3. string
   unique recording id (containing the channel id and recording start date)
4. string
   status message
5. string
   token (the token that was specified by the client during the request).

Since:

61

See Also:

IBackend.queryGenPixmap2(String, IProgramInfo), IPixmapGenerated, Constant Field Values

Method Detail

getName

String getName()

Gets the name of this command.

Returns:

the name of the command, e.g. MYTH_PROTO_VERSION

getCommandArguments

List<String> getCommandArguments()

Gets the arguments of this command.

Returns:

the command arguments, e.g. Playback sycamore 0

getCommandArgument

String getCommandArgument(int idx)

Returns the command argument at the given position. If e.g. the whole command is ANN Playback sycamore 0, getCommandArgument(0) returns Playback.

Parameters:

idx - the position of the requested argument.

Returns:

the command argument at the given position.

getCommandArgumentsLength

int getCommandArgumentsLength()

Gets the amount of available command arguments

Returns:

the amount of command arguments