MythTv XML Protocol

MythXML - Description.
-=>TODO: Describe what this collection of methods are for. <=-
GetServDesc - Retrieve MythBackend's uPnp Service Description xml.
Params: | none |  |
GetConnectionInfo - Retrieves Database Connection Information.
Pin: |  |
Params: | Pin |  | Security Id (only used if backend has defined a value)
GetHosts - Retrieves a list of unique Host Names from the settings table.
Params: | none |  |
GetKeys - Retrieves a list of unique Key Names available in the settings table.
Params: | none |  |
GetSetting - Retrieves a Setting from the backend.
Key: |  |
HostName: |  |
Default: |  |
Params: | Key |  | Name of setting to access (all Keys if not supplied)
| HostName |  | Name of Host for setting (null if not supplied)
| Default |  | Default value to return if not found
PutSetting - Sets a Setting on the backend.
Key: |  |
HostName: |  |
Value: |  |
Params: | Key |  | Name of setting to save. <required>
| HostName |  | Name of Host for setting (null if not supplied)
| Value |  | Value to set.
GetProgramGuide - Retrieves the Program Guide for a given time frame.
StartTime: |  |
EndTime: |  |
StartChanId: |  |
NumOfChannels: |  |
Details: | True False |
* Note: maximum of 1000 programs returned per call
Params: | StartTime |  | Starting Time (CCYY-MM-DDTHH:MM) <required>
| EndTime |  | EndTime must be after StartTime <required>
| StartChanId |  | Return guide from the provided Channel Id, if omitted, return from beginning.
| NumOfChannels |  | Number of sequential channels to return for requested time period. If omitted, 1 channel is returned. -1 returns all channels.
| Details |  | Should all attributes be returned
GetProgramDetails - Retrieves Details about a specific program.
ChanId: |  |
StartTime: |  |
Params: | ChanId |  | ChannelId of program. <required>
| StartTime |  | StartTime of program (CCYY-MM-DDTHH:MM). <required>
GetChannelIcon - Retrieves the Channel Icon for a given Channel Id.
ChanId: |  |
Params: | ChanId |  | Channel Id to retrieve Icon for <required>
GetRecorded - Retrieves the list of Recorded Shows from the backend.
Descending: | True False |  |
Params: | Descending |  | NON-ZERO = Descending, 0 = Ascending
GetExpiring - Gets the full list of programs that can expire in expiration order.
Params: | none |  |
GetPreviewImage - Retrieves a Preview Image of a recording.
ChanId: |  |
StartTime: |  |
Width: |  |
Height: |  |
SecsIn: |  |
Params: | ChanId |  | ChannelId of recording. <required>
| StartTime |  | StartTime of recording (CCYY-MM-DDTHH:MM). <required>
| Width |  | Width of image (optional)
| Height |  | Height of image (optional)
| SecsIn |  | Number of Seconds into video to extract image (optional)
GetRecording - Retrieves the actual recording.
ChanId: |  |
StartTime: |  |
Params: | ChanId |  | ChannelId of recording. <required>
| StartTime |  | StartTime of recording (CCYY-MM-DDTHH:MM). <required>
GetVideo - Retrieves Video.
Id: |  |
Params: | Id |  | Id of the video to retrieve <required>
GetMusic - Retrieves actual song.
Id: |  |
Params: | Id |  | Id of the Song to retrieve <required>
Results |