|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMythCommand
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
.
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 []:[]
.[]:[]
.
33 | QUERY_REMOTEENCODER 1[]:[]IS_BUSY |
46 | 1[]:[]Tuner 1[]:[]1[]:[]1[]:[]1[]:[]0[]:[]1002 |
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.
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
.
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 . |
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 |
---|
static final String MYTH_PROTO_VERSION
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 |
ACCEPT
| REJECT
static final String ANN
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 connectionsANN_MONITOR
: for non blocking monitor connections (Since 22)ANN_FILE_TRANSFER
: for file transfer connectionsANN_RING_BUFFER
: for ring-buffer connections (Removed in 20)ANN_SLAVEBACKEND
: used by slave backendsANN_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 |
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 ValuesVersion | 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 |
static final String DONE
This commands signals the backend that the client will release the connection.
MythTV protocol example: | |
4 | DONE |
static final String QUERY_RECORDINGS
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 |
here
for all properties)
static final String QUERY_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 |
QUERY_RECORDING_BASENAME
QUERY_RECORDING_TIMESLOT
static final String QUERY_FREE_SPACE
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[]:[] |
static final String QUERY_FREE_SPACE_LIST
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[]:[] |
TotalDiskSpace
and is a summary of all other entries.
static final String QUERY_FREESPACE
QUERY_FREE_SPACE
instead
MythTV protocol example: | |
15 | QUERY_FREESPACE |
14 | 30534[]:[]9630 |
static final String QUERY_FREE_SPACE_SUMMARY
This command summarizes the free space on all backends.
MythTV protocol example: | |
24 | QUERY_FREE_SPACE_SUMMARY |
32 | 0[]:[]18761596[]:[]0[]:[]2985552 |
static final String QUERY_LOAD
This command queries the system load on the backend.
MythTV protocol example: | |
10 | QUERY_LOAD |
22 | 0.04[]:[]0.03[]:[]0.08 |
static final String QUERY_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 |
static final String QUERY_MEMSTATS
This command queries the memory usage of the backend.
MythTV protocol example: | |
14 | QUERY_MEMSTATS |
26 | 121[]:[]11[]:[]917[]:[]917 |
static final String QUERY_CHECKFILE
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[]:[] |
1
=exists, 0
=not found
static final String QUERY_GUIDEDATATHROUGH
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 |
static final String QUEUE_TRANSCODE
here
for all properties)0
static final String QUEUE_TRANSCODE_STOP
here
for all properties)0
static final String QUEUE_TRANSCODE_CUTLIST
here
for all properties)0
static final String STOP_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 |
here
for all properties)-1
if no recorder is recording the program)
static final String CHECK_RECORDING
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 |
here
for all properties)0
if no recorder was found)
static final String DELETE_RECORDING
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:
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 |
here
for all properties)-1
=file deleted, -2
=file not found, if the recording is in progress the recorder ID is returned.-1
=file deleted, -2
=file not found, if the recording is in progress the recorder ID is returned.
FORGET_RECORDING
,
FORCE_DELETE_RECORDING
,
IBackend.deleteRecording(IProgramInfo)
,
Constant Field ValuesVersion | 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 |
static final String DELETE_FAILED_RECORDING
This command was only available in 38, therefore we will not implement it.
static final String FORCE_DELETE_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 |
here
for all properties)-1
=file deleted, -2
=file not found, or recorder-id
if the recording is in progress the recorder ID is returned.
static final String REACTIVATE_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
.
here
for all properties)1
=success, 0
=failed
static final String UNDELETE_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:
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 |
here
for all properties)-1
=error, 0
=ok-1
=error, 0
=ok
DELETE_RECORDING
,
IBackend.undeleteRecording(IProgramInfo)
,
Wiki,
Constant Field ValuesVersion | 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 |
static final String RESCHEDULE_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 |
-1
ro reschedule all recordings)0
| 1
static final String FORGET_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 |
here
for all properties)0
always returns this value.
static final String QUERY_GETALLPENDING
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 |
static final String QUERY_GETALLSCHEDULED
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 |
here
for all properties)
static final String QUERY_GETCONFLICTING
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 |
here
for all properties)
static final String QUERY_GETEXPIRING
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 |
here
for all properties)
static final String GET_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 |
-1
if no recorder is free)nohost
if no recorder is free)-1
if no recorder is free)
static final String GET_FREE_RECORDER_COUNT
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 |
static final String GET_FREE_RECORDER_LIST
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 |
static final String GET_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 |
-1
if not specified)-1
if no recorder is free)nohost
if no recorder is free)-1
if no recorder is free)
static final String QUERY_RECORDER
static final String SET_NEXT_LIVETV_DIR
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 |
OK
| bad
static final String SET_CHANNEL_INFO
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 |
0
=error, 1
=success
static final String QUERY_REMOTEENCODER
static final String GET_RECORDER_FROM_NUM
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 |
nohost
if no recorder was found)-1
if no recorder was found)
static final String GET_RECORDER_NUM
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 |
here
for all properties)-1
if no recorder was found)nohost
if no recorder was found)-1
if no recorder was found)
static final String QUERY_FILETRANSFER
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:
SET_TIMEOUT
IS_OPEN
REOPEN
SEEK
REQUEST_BLOCK
WRITE_BLOCK
DONE
static final String QUERY_GENPIXMAP
QUERY_GENPIXMAP2
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 |
here
for all properties)OK
static final String QUERY_GENPIXMAP2
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 |
here
for all properties)OK
static final String QUERY_PIXMAP_LASTMODIFIED
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 |
here
for all properties)
static final String QUERY_PIXMAP_GET_IF_MODIFIED
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 |
-1
if not required0
or the limit is exeeded only the timestamp will be returned.here
for all properties)ERROR
1: Parameter list too short
| 2: Invalid ProgramInfo
| 3: Failed to read preview file
|
5: Could not locate mythbackend that made this recording
WARNING
1: Preview file too big ...
| 2: Could not locate requested file
| 4: Preview file is invalid
static final String QUERY_ISRECORDING
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 |
static final String 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.
static final String FILL_PROGRAM_INFO
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[]:[] |
here
for all properties)here
for all properties)
static final String LOCK_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[]:[][]:[][]:[] |
-1
if no card can be found with the specified ID; -2
if tuner is already locked)
static final String FREE_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 |
OK
| FAILED
static final String QUERY_IS_ACTIVE_BACKEND
This command checks if the given backend is active.
MythTV protocol example: | |
35 | QUERY_IS_ACTIVE_BACKEND[]:[]mythbox |
4 | TRUE |
TRUE
| FALSE
static final String QUERY_ACTIVE_BACKENDS
This command returns the names of all currently active backends.
MythTV protocol example: | |
21 | QUERY_ACTIVE_BACKENDS |
27 | 2[]:[]mythbox1[]:[]mythbox2 |
static final String QUERY_COMMBREAK
static final String QUERY_CUTLIST
static final String QUERY_BOOKMARK
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 |
IBackend.queryBookmark(IProgramInfo)
,
Wiki,
Constant Field Valuesstatic final String SET_BOOKMARK
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 |
OK
| FAILED
static final String QUERY_SETTING
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 |
-1
for unknown settings
static final String SET_SETTING
This command is used to set given setting on the remote host.
MythTV protocol example: | |
20 | SET_SETTING mythtv Language DE |
2 | OK |
OK
static final String ALLOW_SHUTDOWN
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 |
OK
static final String BLOCK_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 |
OK
static final String SHUTDOWN_NOW
This command can be used to shutdown a slave backend.
MythTV protocol example: | |
12 | SHUTDOWN_NOW |
static final String BACKEND_MESSAGE
This type of command represents a MythTV event message. params:
static final String REFRESH_BACKEND
This command forces the backend to reload the backend settings.
MythTV protocol example: | |
15 | REFRESH_BACKEND |
2 | OK |
OK
static final String OK
static final String UNKNOWN_COMMAND
static final String QUERY_TIME_ZONE
MythTV protocol example: | |
15 | QUERY_TIME_ZONE |
46 | Europe/Vienna[]:[]7200[]:[]2010-05-24T11:55:14 |
static final String QUERY_FILE_EXISTS
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 |
IBackend.queryFileExists(IProgramInfo)
,
IBackend.queryFileExists(String, String)
,
Constant Field ValuesVersion | 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 |
static final String QUERY_FILE_HASH
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 |
static final String GO_TO_SLEEP
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 |
OK
| ERROR: xxx
static final String QUERY_HOSTNAME
A command to determine the hostname of a backend.
MythTV protocol example: | |
14 | QUERY_HOSTNAME |
7 | mythbox |
static final String QUERY_SG_GETFILELIST
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 |
static final String QUERY_SG_FILEQUERY
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 |
IStorageGroupFile
,
IBackend.queryStorageGroupFile(String, String, String)
,
Wiki,
Constant Field ValuesVersion | 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 |
static final String DOWNLOAD_FILE
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 |
OK
| ERROR
static final String DOWNLOAD_FILE_NOW
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 |
OK
| ERROR
static final String SCAN_VIDEOS
This command triggers the scanning of all video folders.
OK
| ERROR
static final String DELETE_FILE
This command allows to delete a remote file.
MythTV protocol example: | |
37 | DELETE_FILE[]:[]/logo.svg[]:[]Default |
1 | 1 |
0
| 1
static final String ANN_PLAYBACK
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 |
OK
static final String ANN_SLAVEBACKEND
This command registers a client to the backend and announces a slave backend connection.
static final String ANN_MEDIASERVER
This command registers a client to the backend and announces a media-server connection.
static final String ANN_RING_BUFFER
This command registers a client to the backend and announces a ringbuffer connection.
MythTV protocol example: | |
25 | ANN RingBuffer sycamore 1 |
2 | OK |
RingBuffer
ok
static final String ANN_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 |
IBackend.annotateFileTransfer(org.jmythapi.protocol.response.IProgramInfo)
,
IFileTransfer
,
Constant Field ValuesVersion | 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 |
static final String ANN_MONITOR
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 |
OK
static final String QUERY_FILETRANSFER_IS_OPEN
This command queries, whether a file socket is currently open.
MythTV protocol example: | |
33 | QUERY_FILETRANSFER 17[]:[]IS_OPEN |
1 | 1 |
IS_OPEN
static final String QUERY_FILETRANSFER_DONE
MythTV protocol example: | |
30 | QUERY_FILETRANSFER 17[]:[]DONE |
2 | ok |
DONE
OK
static final String QUERY_FILETRANSFER_REQUEST_BLOCK
MythTV protocol example: | |
49 | QUERY_FILETRANSFER 17[]:[]REQUEST_BLOCK[]:[]65536 |
5 | 65536 |
REQUEST_BLOCK
static final String QUERY_FILETRANSFER_SEEK
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 |
static final String QUERY_FILETRANSFER_SET_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 |
SET_TIMEOUT
1
=fast, 0
=slow timeoutok
static final String QUERY_FILETRANSFER_WRITE_BLOCK
static final String QUERY_FILETRANSFER_REOPEN
REOPEN
1
=ok, 0
=error
static final String QUERY_RECORDING_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[]:[] |
BASENAME
<channelId>_<recordStartingTime>.mpg
, e.g. 1057_20100811133747.mpg
)OK
| ERROR
here
for all properties)
IBackend.queryRecording(String)
,
QUERY_RECORDING
,
Wiki,
Constant Field Valuesstatic final String QUERY_RECORDING_TIMESLOT
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[]:[] |
TIMESLOT
1058
)2010-08-11T13:37:47
)OK
| ERROR
here
for all properties)
static final String QUERY_REMOTEENCODER_GET_STATE
MythTV protocol example: | |
35 | QUERY_REMOTEENCODER 1[]:[]GET_STATE |
1 | 0 |
GET_STATE
here
for all states)
static final String QUERY_REMOTEENCODER_GET_FLAGS
MythTV protocol example: | |
35 | QUERY_REMOTEENCODER 1[]:[]GET_FLAGS |
10 | 1073741826 |
GET_FLAGS
here
for all flags
static final String QUERY_REMOTEENCODER_IS_BUSY
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 |
IS_BUSY
static final String QUERY_REMOTEENCODER_MATCHES_RECORDING
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 |
MATCHES_RECORDING
here
for all properties)0
=no, 1
=yes
static final String QUERY_REMOTEENCODER_START_RECORDING
This command tells the encoder to start recording the program as soon as possible.
START_RECORDING
here
for all properties)
static final String QUERY_REMOTEENCODER_RECORD_PENDING
Tells the encoder that there is a pending recording in "secsleft" seconds.
ok
static final String QUERY_REMOTEENCODER_CANCEL_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 |
CANCEL_NEXT_RECORDING
0
=cancel, 1
=allowok
static final String QUERY_REMOTEENCODER_STOP_RECORDING
This command stops a currently active recording on the given recoder.
MythTV protocol example: | |
40 | QUERY_REMOTEENCODER 1[]:[]STOP_RECORDING |
2 | OK |
STOP_RECORDING
ok
static final String QUERY_REMOTEENCODER_GET_MAX_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 |
GET_MAX_BITRATE
static final String QUERY_REMOTEENCODER_GET_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 |
GET_CURRENT_RECORDING
here
for all properties)
static final String QUERY_REMOTEENCODER_GET_FREE_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 |
GET_FREE_INPUTS
EMPTY_LIST
static final String QUERY_REMOTEENCODER_GET_SLEEPSTATUS
This command returns the current Sleep Status of the encoder.
MythTV protocol example: | |
41 | QUERY_REMOTEENCODER 1[]:[]GET_SLEEPSTATUS |
1 | 8 |
GET_SLEEPSTATUS
static final String QUERY_REMOTEENCODER_GET_RECORDING_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 |
GET_RECORDING_STATUS
IProgramRecordingStatus.Status
for all possible values)
static final String QUERY_RECORDER_IS_RECORDING
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 |
IS_RECORDING
1
=busy, 0
=idle
static final String QUERY_RECORDER_GET_FRAMERATE
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 |
GET_FRAMERATE
-1
if not recording)
static final String QUERY_RECORDER_GET_FRAMES_WRITTEN
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 |
GET_FRAMES_WRITTEN
static final String QUERY_RECORDER_GET_FILE_POSITION
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 |
GET_FILE_POSITION
static final String QUERY_RECORDER_GET_FREE_SPACE
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.
GET_FREE_SPACE
static final String QUERY_RECORDER_GET_MAX_BITRATE
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 |
GET_MAX_BITRATE
static final String QUERY_RECORDER_GET_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 |
GET_CURRENT_RECORDING
here
for all properties)
static final String QUERY_RECORDER_GET_KEYFRAME_POS
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 |
static final String QUERY_RECORDER_FILL_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 |
static final String QUERY_RECORDER_FILL_DURATION_MAP
Returns time position in RingBuffer of a keyframes according to recorder.
FILL_DURATION_MAP
static final String QUERY_RECORDER_SETUP_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 |
SETUP_RING_BUFFER
1
=picture in pictureok
| not_ok
static final String QUERY_RECORDER_GET_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[]:[] |
GET_RECORDING
here
for all properties)
static final String QUERY_RECORDER_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
STOP_PLAYING
ok
static final String QUERY_RECORDER_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 |
FRONTEND_READY
ok
static final String QUERY_RECORDER_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 |
CANCEL_NEXT_RECORDING
1
=cancel, 0
=continue ok
static final String QUERY_RECORDER_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 |
ok
static final String QUERY_RECORDER_STOP_LIVETV
This command tells the backend to stop a "Live TV" recorder.
MythTV protocol example: | |
32 | QUERY_RECORDER 1[]:[]STOP_LIVETV |
2 | ok |
STOP_LIVETV
ok
static final String QUERY_RECORDER_PAUSE_RECORDER
QUERY_RECORDER_PAUSE
instead.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.
PAUSE_RECORDER
ok
static final String QUERY_RECORDER_PAUSE
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 |
PAUSE
ok
static final String QUERY_RECORDER_UNPAUSE
This command tells the backend to unpause a recorder.
This command was only available in 18, therefore we will not implement it.
UNPAUSE
ok
static final String QUERY_RECORDER_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 |
FINISH_RECORDING
ok
static final String QUERY_RECORDER_SET_LIVE_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 |
SET_LIVE_RECORDING
-1
(currently only -1 is supported)ok
static final String QUERY_RECORDER_TOGGLE_INPUTS
QUERY_RECORDER_GET_CONNECTED_INPUTS
,
QUERY_RECORDER_GET_INPUT
and QUERY_RECORDER_SET_INPUT
This command tells are recorder to change to the next input.
MythTV protocol example: | |
34 | QUERY_RECORDER 1[]:[]TOGGLE_INPUTS |
2 | ok |
TOGGLE_INPUTS
ok
static final String QUERY_RECORDER_GET_CONNECTED_INPUTS
QUERY_RECORDER_GET_FREE_INPUTS
GET_CONNECTED_INPUTS
EMPTY_LIST
static final String QUERY_RECORDER_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 |
GET_FREE_INPUTS
static final String QUERY_RECORDER_GET_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 |
GET_INPUT
UNKNOWN
if unknown)
static final String QUERY_RECORDER_SET_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 |
SET_INPUT
SwitchToNextInput
UNKNOWN
if unknown)
static final String QUERY_RECORDER_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 |
TOGGLE_CHANNEL_FAVORITE
ok
static final String QUERY_RECORDER_CHANGE_CHANNEL
This command forces the recorder to change to the next or previous channel.
ATTENTION: You must pause the recorder before doing this.
CHANGE_CHANNEL
ok
static final String QUERY_RECORDER_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 |
SET_CHANNEL
ok
static final String QUERY_RECORDER_SET_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 |
SET_SIGNAL_MONITORING_RATE
0
to disable, -1
to preserve old value.)1
SIGNAL messages are sent to the frontend, if 0
SIGNAL messages will not be sent, and if -1
the old value is preserved.)
static final String QUERY_RECORDER_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 |
GET_COLOUR
-1
on error)
static final String QUERY_RECORDER_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 |
GET_CONTRAST
-1
on error)
static final String QUERY_RECORDER_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 |
GET_BRIGHTNESS
-1
on error)
static final String QUERY_RECORDER_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 |
GET_HUE
-1
on error)
static final String QUERY_RECORDER_CHANGE_COLOUR
Changes the colour of a recording.
Note: In practice this only works with frame grabbing recorders.
CHANGE_COLOUR
1
=up, 0
=down-1
on error)
static final String QUERY_RECORDER_CHANGE_CONTRAST
Changes the contrast of a recording.
Note: In practice this only works with frame grabbing recorders.
CHANGE_CONTRAST
1
=up, 0
=down-1
on error)
static final String QUERY_RECORDER_CHANGE_BRIGHTNESS
Changes the brightness of a recording.
Note: In practice this only works with frame grabbing recorders.
CHANGE_BRIGHTNESS
1
=up, 0
=down-1
on error)
static final String QUERY_RECORDER_CHANGE_HUE
Changes the hue of a recording.
Note: In practice this only works with frame grabbing recorders.
CHANGE_HUE
1
=up, 0
=down-1
on error)
static final String QUERY_RECORDER_CHECK_CHANNEL
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 |
CHECK_CHANNEL
1
=channel available
static final String QUERY_RECORDER_SHOULD_SWITCH_CARD
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 |
SHOULD_SWITCH_CARD
0
=switch not required
static final String QUERY_RECORDER_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 |
CHECK_CHANNEL_PREFIX
static final String QUERY_RECORDER_GET_NEXT_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[]:[] |
GET_NEXT_PROGRAM_INFO
IRecorder.getNextProgramInfo(org.jmythapi.IBasicChannelInfo, org.jmythapi.protocol.request.EChannelBrowseDirection, java.util.Date)
,
IRecorderNextProgramInfo
,
Constant Field ValuesVersion | Date | Additional Version Info | |
---|---|---|---|
Added | 00 | ||
Changed | 08 | 2004-05-09 | Changelog, MythTV-Release: 0.15, SVN-Rev.: 3621 |
Removed | -1 |
static final String QUERY_RECORDER_GET_PROGRAM_INFO
QUERY_RECORDER_GET_RECORDING
or QUERY_RECORDER_GET_NEXT_PROGRAM_INFO
instead.
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 |
GET_PROGRAM_INFO
IRecorder.getProgramInfo()
,
IRecorderProgramInfo
,
Constant Field ValuesVersion | 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 |
static final String QUERY_RECORDER_GET_INPUT_NAME
QUERY_RECORDER_GET_INPUT
instead.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 |
GET_INPUT_NAME
static final String QUERY_RECORDER_GET_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 |
GET_CHANNEL_INFO
static final String QUERY_RECORDER_REQUEST_BLOCK_RINGBUF
Command to read a data block from a ringbuffer.
REQUEST_BLOCK_RINGBUF
static final String QUERY_RECORDER_SEEK_RINGBUF
Command to seek within a ringbuffer.
MythTV protocol example: | |
63 | QUERY_RECORDER 1[]:[]SEEK_RINGBUF[]:[]0[]:[]0[]:[]0[]:[]0[]:[]0 |
7 | 0[]:[]0 |
SEEK_RINGBUF
static final String QUERY_RECORDER_DONE_RINGBUF
Informs a backend that a ringbuffer is not required anymore.
MythTV protocol example: | |
33 | QUERY_RECORDER 1[]:[]DONE_RINGBUF |
2 | OK |
DONE_RINGBUF
OK
static final String 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 |
static final String BACKEND_MESSAGE_UPDATE_FILE_SIZE
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 |
UPDATE_FILE_SIZE
static final String BACKEND_MESSAGE_RECORDING_LIST_CHANGE
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:
BACKEND_MESSAGE_UPDATE_PROG_INFO
.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
RECORDING_LIST_CHANGE
DELETE
RECORDING_LIST_CHANGE
ADD
RECORDING_LIST_CHANGE
UPDATE
here
for all properties)
IRecordingListChangeSingle
,
IRecordingListChangeList
,
IRecordingListChangeAdd
,
IRecordingListChangeUpdate
,
IRecordingListChangeDelete
,
Constant Field ValuesVersion | 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 |
static final String BACKEND_MESSAGE_UPDATE_PROG_INFO
BACKEND_MESSAGE_RECORDING_LIST_CHANGE
UPDATE
.
This message tells the frontends to update a particular recording.
This is e.g. used for bookmark updates.
BACKEND_MESSAGE_RECORDING_LIST_CHANGE
.
UPDATE_PROG_INFO
here
for all properties)
static final String BACKEND_MESSAGE_MASTER_UPDATE_PROG_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.
MASTER_UPDATE_PROG_INFO
here
for all properties)
static final String BACKEND_MESSAGE_LIVETV_WATCH
LIVETV_WATCH
0
(fixed value; unknown purpose)
static final String BACKEND_MESSAGE_QUIT_LIVETV
static final String BACKEND_MESSAGE_LIVETV_CHAIN
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 |
ILiveTvChainUpdate
,
Constant Field Valuesstatic final String 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 |
IAskRecording
,
QUERY_REMOTEENCODER_CANCEL_NEXT_RECORDING
,
Constant Field Valuesstatic final String BACKEND_MESSAGE_SCHEDULE_CHANGE
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 |
SCHEDULE_CHANGE
IScheduleChange
,
Constant Field Valuesstatic final String 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 |
CLEAR_SETTINGS_CACHE
static final String 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 |
RESET_IDLETIME
static final String 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 |
SYSTEM_EVENT
ISystemEvent
,
Constant Field Valuesstatic final String BACKEND_MESSAGE_COMMFLAG_START
TODO:
ICommflagStart
,
Constant Field Valuesstatic final String BACKEND_MESSAGE_SHUTDOWN_COUNTDOWN
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 |
SHUTDOWN_COUNTDOWN
-1
if shutdown countdown is aborted)
IShutdownCountdown
,
Constant Field Valuesstatic final String BACKEND_MESSAGE_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 |
SHUTDOWN_NOW
static final String BACKEND_MESSAGE_SIGNAL
TODO:
SIGNAL
static final String 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:
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 |
DOWNLOAD_FILE
UPDATE
)DOWNLOAD_FILE
FINISHED
)Unknown error
on no error})0
on no error})
IDownloadFile
,
IDownloadFileUpdate
,
IDownloadFileFinished
,
IBackend.downloadFile(java.net.URI, String, String)
,
Constant Field Valuesstatic final String 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 |
VIDEO_LIST_CHANGE
deleted
, added
or moved
)
IBackend.scanVideos()
,
IVideoListChange
,
Constant Field Valuesstatic final String 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 |
VIDEO_LIST_NO_CHANGE
IBackend.scanVideos()
,
IVideoListNoChange
,
Constant Field Valuesstatic final String BACKEND_MESSAGE_GENERATED_PIXMAP
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:
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 |
GENERATED_PIXMAP
OK
)here
for all properties)GENERATED_PIXMAP
ERROR
)
IBackend.queryGenPixmap2(String, IProgramInfo)
,
IPixmapGenerated
,
Constant Field ValuesMethod Detail |
---|
String getName()
MYTH_PROTO_VERSION
List<String> getCommandArguments()
Playback sycamore 0
String getCommandArgument(int idx)
ANN Playback sycamore 0
,
getCommandArgument(0)
returns Playback
.
idx
- the position of the requested argument.
int getCommandArgumentsLength()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |