From MythTV Official Wiki
Services API V2 Conversion
Capture Service API List (8)
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| AddCaptureCard
|
Yes
|
Add a brand new capture device to the database.
|
|
Not started
|
|
| AddCardInput
|
Yes
|
Add a new card input to the database, and associate it with a video listings source.
|
|
Not Started
|
|
| GetCaptureCard
|
No
|
Get info on a specific capture device, by card id.
|
|
Not Started
|
|
| GetCaptureCardList
|
No
|
Get a list of configured capture devices globally, on a certain host, or of a certain type.
|
|
Not started
|
|
| RemoveCaptureCard
|
Yes
|
Remove a particular capture device from the database, by card id.
|
|
Not started
|
|
| RemoveCardInput
|
Yes
|
Remove a particular card input from the database, by card input id.
|
|
Not Started
|
|
| UpdateCaptureCard
|
Yes
|
Change a specific setting value for a specific capture device.
|
|
Not Started
|
|
| UpdateCardInput
|
Yes
|
Change a specific setting value for a specific card input id.
|
|
Not started
|
|
Channel Service API List (15)
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| AddDBChannel
|
Yes
|
Add a new channel to the database.
|
|
Not Started
|
|
| AddVideoSource
|
Yes
|
Add a new video source.
|
|
Not started
|
|
| FetchChannelsFromSource
|
No
|
Get a list of channels for a specific source.
|
|
Not Started
|
|
| GetChannelInfo
|
No
|
Get info on a specific channel.
|
|
Not Started
|
|
| GetChannelInfoList
|
No
|
Get a list of configured channels.
|
|
Not started
|
|
| GetDDLineupList
|
No
|
Get Data Direct lineup.
|
|
Not started
|
|
| GetVideoMultiplex
|
No
|
Get the video multiplexes for a specific multiplex ID.
|
|
Not Started
|
|
| GetVideoMultiplexList
|
No
|
Get a list of all video multiplexes.
|
|
Not started
|
|
| GetVideoSource]]
|
No
|
Get individual video source.
|
|
Not started
|
|
| GetVideoSourceList
|
No
|
Get all video sources. Note, usernames/passwords are included.
|
|
Not Started
|
|
| GetXMLTVIdList
|
No
|
Get a list of XMLTVIDs for a given source ID.
|
|
Not started
|
|
| RemoveDBChannel
|
Yes
|
Remove a particular channel from the database.
|
|
Not started
|
|
| RemoveVideoSource
|
Yes
|
Remove a specific video source.
|
|
Not Started
|
|
| UpdateDBChannel
|
Yes
|
Update a specific channel's database information.
|
|
Not started
|
|
| UpdateVideoSource
|
Yes
|
Change a specific setting value for a specific video source.
|
|
Not Started
|
|
Content Service API List (22)
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| AddLiveStream
|
No
|
Start a HTTP Live Stream transcode for a given file and storage group.
|
|
Not started
|
|
| AddRecordingLiveStream
|
No
|
Start a HTTP Live Stream transcode for a given ChanId and StartTime.
|
|
Not Started
|
|
| AddVideoLiveStream
|
No
|
Start a HTTP Live Stream transcode for a given Video ID.
|
|
Not started
|
|
| DownloadFile
|
Yes
|
Instruct the backend to download a remote file into a storage group.
|
|
Not Started
|
|
| GetAlbumArt
|
No
|
Display, and optionally scale, the album art for a given music file's database id number.
|
|
Not Started
|
|
| GetDirList
|
No
|
Get a list of directories
|
|
Not Started
|
|
| GetFile
|
No
|
Download a given file from a given storage group.
|
|
Not started
|
|
| GetFileList
|
No
|
Get a list of files in a specified storage group.
|
|
Not started
|
|
| GetHash
|
No
|
Perform a unique identifying hash on a given file in a given storage group.
|
|
Not started
|
|
| GetImageFile
|
No
|
Display, and optionally scale, an image file from a given storage group.
|
|
Not Started
|
|
| GetLiveStream
|
No
|
Get the stream status data for a given HTTP Live Stream.
|
|
Not Started
|
|
| GetLiveStreamList
|
No
|
Get the stream status data for all available HTTP Live Streams.
|
|
Not started
|
|
| GetMusic
|
No
|
Download a given music file by database id.
|
|
Not started
|
|
| GetPreviewImage
|
No
|
Display, and optionally scale, an preview thumbnail for a given recording by timestamp, chanid and starttime.
|
|
Not started
|
|
| GetProgramArtworkList
|
No
|
Display a list of artwork available for a program by inetref and season.
|
|
Not Started
|
|
| GetRecording
|
No
|
Download a given recording file by chanid and starttime.
|
|
Not Started
|
|
| GetRecordingArtwork
|
No
|
Display, and optionally scale, an image file of a given type (coverart, banner, fanart) for a given recording's inetref and season number.
|
|
Not Started
|
|
| GetRecordingArtworkList
|
No
|
Display a list of artwork available for a recording by start time and channel id.
|
|
Not started
|
|
| GetVideo
|
No
|
Download a given video by database id.
|
|
Not Started
|
|
| GetVideoArtwork
|
No
|
Display, and optionally scale, an image file of a given type (coverart, banner, fanart) for a given video's database id number.
|
|
Not started
|
|
| RemoveLiveStream
|
No
|
Stop transcoding a given HTTP Live Stream, and remove the transcoded files.
|
|
Not started
|
|
| StopLiveStream
|
No
|
Stop transcoding a given HTTP Live Stream, leaving the transcoded files intact.
|
|
Not Started
|
|
Dvr Service API List (51)
| API Command
|
Service Version
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| AddDontRecordSchedule
|
?
|
No
|
TBC
|
|
Not started
|
|
| AddRecordSchedule
|
?
|
Yes
|
Add a single recording rule, by record id.
|
|
Not started
|
|
| AddRecordedCredits
|
7.0
|
Yes
|
Add credits to a currently recorded program.
|
|
Not Started
|
|
| AddRecordedProgram
|
7.0
|
Yes
|
Add a recorded program entry into MythTV.
|
|
Not started
|
|
| AllowReRecord
|
?
|
No
|
TBC
|
|
Not Started
|
|
| DeleteRecording
|
6.0
|
Yes
|
Delete a recording, by recording id
|
|
Not Started
|
|
| DisableRecordSchedule
|
?
|
Yes
|
Disable a recording schedule, by record id.
|
|
Not started
|
|
| DupInToDescription
|
?
|
No
|
TBC
|
|
Not started
|
|
| DupInToString
|
?
|
No
|
TBC
|
|
Not Started
|
|
| DupMethodToDescription
|
?
|
No
|
TBC
|
|
Not started
|
|
| DupMethodToString
|
?
|
No
|
TBC
|
|
Not Started
|
|
| EnableRecordSchedule
|
?
|
Yes
|
Enable a recording schedule, by record id.
|
|
Not Started
|
|
| GetConflictList
|
?
|
No
|
Query information on upcoming items which will not record due to conflicts.
|
|
Not Started
|
|
| GetEncoderList
|
?
|
No
|
Query information on configured capture devices, and their current activity.
|
|
Not Started
|
|
| GetExpiringList
|
?
|
No
|
Query information on recorded programs which are set to expire.
|
|
Not started
|
|
| GetInputList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetOldRecordedList
|
?
|
No
|
TBC
|
|
Not Started
|
|
| GetPlayGroupList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetProgramCategories
|
?
|
No
|
TBC
|
|
Not Started
|
|
| GetRecGroupList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetRecRuleFilterList
|
?
|
No
|
TBC
|
|
Not Started
|
|
| GetRecStorageGroupList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetRecordSchedule
|
?
|
No
|
Return a single recording rule, by record id.
|
|
Not started
|
|
| GetRecordScheduleList
|
?
|
No
|
Query all configured recording rules, and return them in a list.
|
|
Not Started
|
|
| GetRecorded
|
?
|
No
|
Query information on a single item from recordings.
|
|
Not started
|
|
| GetRecordedCommBreak
|
?
|
No
|
TBC
|
|
Not Started
|
|
| GetRecordedCutList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetRecordedList
|
?
|
No
|
Query information on all recorded programs.
|
|
Not Started
|
|
| GetRecordedMarkup
|
7.0
|
No
|
Retrieve the complete markup and seek tables by Recorded Id
|
|
Not started
|
|
| GetRecordedSeek
|
6.3
|
No
|
Retrieve the seektable, by recording id and type
|
|
Not started
|
|
| GetSavedBookmark
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetTitleInfoList
|
?
|
No
|
TBC
|
|
Not Started
|
|
| GetTitleList
|
?
|
No
|
TBC
|
|
Not started
|
|
| GetUpcomingList
|
?
|
No
|
Query information on all upcoming programs matching recording rules.
|
|
Not Started
|
|
| ManageJobQueue
|
6.6
|
Yes
|
Administer User, Commflag and Metadata jobs
|
|
Not Started
|
|
| ReactivateRecording
|
6.3
|
No
|
Reactivate a stopped recording, by recording id
|
|
Not Started
|
|
| RecStatusToDescription
|
?
|
No
|
TBC
|
|
Not Started
|
|
| RecStatusToString
|
?
|
No
|
TBC
|
|
Not started
|
|
| RecTypeToDescription
|
?
|
No
|
TBC
|
|
Not Started
|
|
| RecTypeToString
|
?
|
No
|
TBC
|
|
Not started
|
|
| RecordedIdForKey
|
?
|
No
|
TBC
|
|
Not Started
|
|
| RecordedIdForPathname
|
?
|
No
|
TBC
|
|
Not started
|
|
| RemoveRecordSchedule
|
?
|
Yes
|
Remove a Recording rule.
|
|
Not started
|
|
| RemoveRecorded
|
?
|
Yes
|
Delete a Recording (deprecated, replaced by DeleteRecording in later versions)
|
|
Not started
|
|
| RescheduleRecordings
|
6.3
|
No
|
Trigger a reschedule
|
|
Not started
|
|
| SetRecordedMarkup
|
7.0
|
Yes
|
Set the markup and seek tables for the given Recorded Id
|
|
Not Started
|
|
| SetSavedBookmark
|
?
|
No
|
TBC
|
|
Not Started
|
|
| StopRecording
|
6.3
|
No
|
Stop a current recording, by recording id
|
|
Not started
|
|
| UnDeleteRecording
|
6.0
|
Yes
|
Un-delete a recording, by recording id
|
|
Not started
|
|
| UpdateRecordSchedule
|
?
|
Yes
|
Update a single recording rule, by record id.
|
|
Not started
|
|
| UpdateRecordedWatchedStatus
|
6.0
|
Yes
|
Mark a recording watched, or unwatched, by recording id
|
|
Not Started
|
|
Frontend Service API List
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| GetStatus
|
No
|
Get the location, playback status, and a variety of other information about the current state of the Frontend.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| SendMessage
|
No (Yes 0.28+)
|
Send a message to the frontend, which will appear as a popup message on the screen.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| SendNotification
|
No (Yes 0.28+)
|
Send a notification to the frontend which will appear in the Notification Center.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| SendAction
|
No (Yes 0.28+)
|
Send an action such as UP, DOWN, SELECT, etc. to the frontend.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| GetActionList
|
No
|
Get a list of actions which can be performed on the frontend using SendAction.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| PlayRecording
|
No (Yes 0.28+)
|
Play a television recording.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| PlayVideo
|
No (Yes 0.28+)
|
Play a video.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
| SendKey
|
Yes (new in 0.28+)
|
Send a window aware key such as UP, DOWN, SELECT, etc. to the frontend.
|
Mark Kendall [0f8333b68c]
|
Complete
|
|
Guide Service API List
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| GetProgramGuide
|
No
|
The the guide information for a particular time period and set of channels
|
|
Not started
|
|
| GetProgramDetails
|
No
|
Get the detailed guide information for a particular program starting at a particular time on a particular channel.
|
|
Not Started
|
|
| GetChannelIcon
|
No
|
Get the icon file for a given channel.
|
|
Not started
|
|
| GetProgramList
|
No
|
Get a filtered list of programs matching the given search criteria.
|
|
Not Started
|
|
| GetChannelGroupList
|
No
|
Get the list of channel groups.
|
|
Not started
|
|
| GetCategoryList
|
No
|
Get a list of program categories.
|
|
Not Started
|
|
| GetStoredSearches
|
No
|
Get the list of stored searches.
|
|
Not started
|
|
| AddToChannelGroup
|
Yes
|
Add a given channel to a channel group.
|
|
Not Started
|
|
| RemoveFromChannelGroup
|
Yes
|
Remove a given channel from a channel group.
|
|
Not started
|
|
Image Service API List
Music Service API List
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| GetTrack
|
Yes
|
Gets metadata for an individual music track
|
|
Not started
|
|
| GetTrackList
|
No
|
Gets metadata for all music tracks
|
|
Not Started
|
|
Myth Service API List
Video Service API List
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| GetVideoList
|
No
|
Get a list of videos and their metadata.
|
|
Not Started
|
|
| GetVideo
|
No
|
Get a single video's metadata by database id.
|
Peter Bennett
|
Started
|
|
| GetVideoByFileName
|
No
|
Get a single video's metadata by filename.
|
|
Not started
|
|
| AddVideo
|
Yes
|
Add a new filename to the video database.
|
|
Not Started
|
|
| RemoveVideoFromDB
|
Yes
|
Remove a single video from the database by database id.
|
|
Not started
|
|
| LookupVideo
|
No
|
Perform an online metadata lookup for a given title, subtitle, inetref, season, or episode number.
|
|
Not Started
|
|
| GetBluray
|
No
|
Query technical data for a Blu-ray disc or folder.
|
|
Not started
|
|
| UpdateVideoMetadata
|
Yes
|
Updates the metadata of a video
|
|
Not Started
|
|
Status Service API List
| API Command
|
POST Required?
|
Description
|
Developer
|
Status
|
Notes
|
| Status
|
No
|
Get Backend Status in HTML
|
|
Not started
|
Predates Services API. Returns only HTML
|
| GetStatusHTML
|
No
|
Get Backend Status in HTML
|
|
Not Started
|
Predates Services API. Returns only HTML
|
| GetStatus
|
No
|
Get Backend Status in XML
|
|
Not started
|
Predates Services API. Returns only XML
|
| xml
|
No
|
Get Backend Status in XML
|
|
Not Started
|
Predates Services API. Returns only XML
|
