Server: |  |  | Port: |  |
Status Settings Program Guide Recorded
Retrieve Backend Status
Method: |  | getStatusHTML |  | Retrieve MythBackend's Status as an HTML page.
Params: | none |  |
| * Note: if no method is given to server:[status port] then HTML status is returned
Method: |  | getStatus |  | Retrieve MythBackend's Status as an XML Document.
Params: | none |  |
Get/Put Settings
Method: |  | getHosts |  | Retrieves a list of unique Host Names from the settings table.
| getKeys |  | Retrieves a list of unique Key Names available in the settings table.
Key: |  |
HostName: |  |
Default: |  |
Method: |  | getSetting |  | Retrieves a Setting from the backend.
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
Key: |  |
HostName: |  |
Value: |  |
Method: |  | putSetting |  | Sets a Setting on the backend.
Params: | Key |  | Name of setting to save. <required>
| HostName |  | Name of Host for setting (null if not supplied)
| Value |  | Value to set.
Get Program Guide
StartTime: |  |
EndTime: |  |
StartChanId: |  |
NumOfChannels: |  |
Details: | True False |
* Note: maximum of 1000 programs returned per call
Method: |  | getProgramGuide |  | Retrieves the Program Guide for a given time frame.
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 sequencal channels to return for requested time period. If omitted, 1 channel is returned. -1 returns all channels.
| Details |  | Should all attributes be returned
ChanId: |  |
StartTime: |  |
Method: |  | getProgramDetails |  | Retrieves Details about a specific program.
Params: | ChanId |  | ChannelId of program. <required>
| StartTime |  | StartTime of program (CCYY-MM-DDTHH:MM). <required>
ChanId: |  |
Method: |  | getChannelIcon |  | Retrieves the Channel Icon for a given Channel Id.
Params: | ChanId |  | Channel Id to retrieve Icon for <required>
Recorded
Descending: | True False |  |
Method: |  | getRecorded |  | Retrieves the list of Recorded Shows from the backend.
Params: | Descending |  | NON-ZERO = Descending, 0 = Ascending
Method: |  | getExpiring |  | Gets the full list of programs that can expire in expiration order.
Params: | none |  |
ChanId: |  |
StartTime: |  |
Method: |  | getPreviewImage |  | Retrieves a Preview Image of a recording.
Params: | ChanId |  | ChannelId of recording. <required>
| StartTime |  | StartTime of recording (CCYY-MM-DDTHH:MM). <required>
ChanId: |  |
StartTime: |  |
Method: |  | getRecording |  | Retrieves the actual recording.
Params: | ChanId |  | ChannelId of recording. <required>
| StartTime |  | StartTime of recording (CCYY-MM-DDTHH:MM). <required>
ChanId: |  |
StartTime: |  |
ForgetOld: |  |
Method: |  | delRecording |  | Deletes a recording.
Params: | ChanId |  | ChannelId of recording to delete. <required>
| StartTime |  | StartTime of recording to delete (CCYY-MM-DDTHH:MM). <required>
| ForgetOld |  | NON-ZERO = Remove from OldRecordings. Default is 0
Results |