Difference between revisions of "Services API V2 Conversion"
From MythTV Official Wiki
m (Fix Myth Service title) |
m (Add Frontend Service) |
||
| Line 585: | Line 585: | ||
| | | | ||
|- | |- | ||
| + | |} | ||
| + | </center> | ||
| + | |||
| + | =Frontend Service API List= | ||
| + | |||
| + | <center> | ||
| + | {| cellpadding="4" border="1" | ||
| + | | align="center" |<b>API Command</b> | ||
| + | | align="center" |<b>POST Required?</b> | ||
| + | | align="center" |<b>Description</b> | ||
| + | | align="center" |<b>Developer</b> | ||
| + | | align="center" |<b>Status</b> | ||
| + | | align="center" |<b>Notes</b> | ||
| + | |- | ||
| + | | style="background:silver" | [[Frontend_Service#GetStatus | GetStatus]] | ||
| + | | style="background:silver" align="center" | No | ||
| + | | style="background:silver" | Get the location, playback status, and a variety of other information about the current state of the Frontend. | ||
| + | | style="background:silver" | | ||
| + | | style="background:silver" | Not started | ||
| + | | style="background:silver" | | ||
| + | |- | ||
| + | | [[Frontend_Service#SendMessage | SendMessage]] | ||
| + | | align="center" | No (Yes 0.28+) | ||
| + | | Send a message to the frontend, which will appear as a popup message on the screen. | ||
| + | | | ||
| + | | Not Started | ||
| + | | | ||
| + | |- | ||
| + | | style="background:silver" | [[Frontend_Service#SendNotification | SendNotification]] | ||
| + | | style="background:silver" align="center" | No (Yes 0.28+) | ||
| + | | style="background:silver" | Send a notification to the frontend which will appear in the Notification Center. | ||
| + | | style="background:silver" | | ||
| + | | style="background:silver" | Not started | ||
| + | | style="background:silver" | | ||
| + | |- | ||
| + | | [[Frontend_Service#SendAction | SendAction]] | ||
| + | | align="center" | No (Yes 0.28+) | ||
| + | | Send an action such as UP, DOWN, SELECT, etc. to the frontend. | ||
| + | | | ||
| + | | Not Started | ||
| + | | | ||
| + | |- | ||
| + | | style="background:silver" | [[Frontend_Service#GetActionList | GetActionList]] | ||
| + | | style="background:silver" align="center" | No | ||
| + | | style="background:silver" | Get a list of actions which can be performed on the frontend using SendAction. | ||
| + | | style="background:silver" | | ||
| + | | style="background:silver" | Not started | ||
| + | | style="background:silver" | | ||
| + | |- | ||
| + | | [[Frontend_Service#PlayRecording | PlayRecording]] | ||
| + | | align="center" | No (Yes 0.28+) | ||
| + | | Play a television recording. | ||
| + | | | ||
| + | | Not Started | ||
| + | | | ||
| + | |- | ||
| + | | style="background:silver" | [[Frontend_Service#PlayVideo | PlayVideo]] | ||
| + | | style="background:silver" align="center" | No (Yes 0.28+) | ||
| + | | style="background:silver" | Play a video. | ||
| + | | style="background:silver" | | ||
| + | | style="background:silver" | Not started | ||
| + | | style="background:silver" | | ||
| + | |- | ||
| + | | [[Frontend_Service#SendKey | SendKey]] | ||
| + | | align="center" | Yes (new in 0.28+) | ||
| + | | Send a window aware key such as UP, DOWN, SELECT, etc. to the frontend. | ||
| + | | | ||
| + | | Not Started | ||
| + | | | ||
|} | |} | ||
</center> | </center> | ||
Revision as of 19:59, 21 June 2021
Contents
Services API V2 Conversion
Capture Service API List
| API Command | POST Required? | Description | Developer | Status | Notes |
| GetCaptureCardList | No | Get a list of configured capture devices globally, on a certain host, or of a certain type. | Not started | ||
| GetCaptureCard | No | Get info on a specific capture device, by card id. | Not Started | ||
| AddCaptureCard | Yes | Add a brand new capture device to the database. | Not started | ||
| UpdateCaptureCard | Yes | Change a specific setting value for a specific capture device. | Not Started | ||
| RemoveCaptureCard | Yes | Remove a particular capture device from the database, by card id. | Not started | ||
| AddCardInput | Yes | Add a new card input to the database, and associate it with a video listings source. | Not Started | ||
| UpdateCardInput | Yes | Change a specific setting value for a specific card input id. | Not started | ||
| RemoveCardInput | Yes | Remove a particular card input from the database, by card input id. | Not Started |
Channel Service API List
| API Command | POST Required? | Description | Developer | Status | Notes |
| GetChannelInfoList | No | Get a list of configured channels. | Not started | ||
| GetChannelInfo | No | Get info on a specific channel. | Not Started | ||
| UpdateDBChannel | Yes | Update a specific channel's database information. | Not started | ||
| AddDBChannel | Yes | Add a new channel to the database. | Not Started | ||
| RemoveDBChannel | Yes | Remove a particular channel from the database. | Not started | ||
| GetVideoSourceList | No | Get all video sources. Note, usernames/passwords are included. | Not Started | ||
| GetVideoSource | No | Get individual video source. | Not started | ||
| UpdateVideoSource | Yes | Change a specific setting value for a specific video source. | Not Started | ||
| AddVideoSource | Yes | Add a new video source. | Not started | ||
| RemoveVideoSource | Yes | Remove a specific video source. | Not Started | ||
| GetDDLineupList | No | Get Data Direct lineup. | Not started | ||
| FetchChannelsFromSource | No | Get a list of channels for a specific source. | Not Started | ||
| GetVideoMultiplexList | No | Get a list of all video multiplexes. | Not started | ||
| GetVideoMultiplex | No | Get the video multiplexes for a specific multiplex ID. | Not Started | ||
| GetXMLTVIdList | No | Get a list of XMLTVIDs for a given source ID. | Not started |
Content Service API List
| API Command | POST Required? | Description | Developer | Status | Notes |
| GetFile | No | Download a given file from a given storage group. | Not started | ||
| GetImageFile | No | Display, and optionally scale, an image file from a given storage group. | Not Started | ||
| GetFileList | No | Get a list of files in a specified storage group. | 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 | ||
| GetProgramArtworkList | No | Display a list of artwork available for a program by inetref and season. | 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 | ||
| GetAlbumArt | No | Display, and optionally scale, the album art for a given music file's database id number. | Not Started | ||
| GetPreviewImage | No | Display, and optionally scale, an preview thumbnail for a given recording by timestamp, chanid and starttime. | Not started | ||
| GetRecording | No | Download a given recording file by chanid and starttime. | Not Started | ||
| GetMusic | No | Download a given music file by database id. | Not started | ||
| GetVideo | No | Download a given video by database id. | Not Started | ||
| GetHash | No | Perform a unique identifying hash on a given file in a given storage group. | Not started | ||
| DownloadFile | Yes | Instruct the backend to download a remote file into a storage group. | Not Started | ||
| 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 | ||
| 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 | ||
| GetFilteredLiveStreamList | No | Get the stream status data for all available HTTP Live Streams created from a given filename. | 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
| API Command | Service Version | POST Required? | Description | Developer | Status | Notes |
| GetUpcomingList | ? | No | Query information on all upcoming programs matching recording rules. | |||
| GetExpiringList | ? | No | Query information on recorded programs which are set to expire. | Not started | ||
| GetRecordedList | ? | No | Query information on all recorded programs. | Not Started | ||
| GetRecorded | ? | No | Query information on a single item from recordings. | 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 | ||
| GetConflictList | ? | No | Query information on upcoming items which will not record due to conflicts. | Not Started | ||
| RemoveRecorded | ? | Yes | Delete a Recording (deprecated, replaced by DeleteRecording in later versions) | Not started | ||
| GetEncoderList | ? | No | Query information on configured capture devices, and their current activity. | Not Started | ||
| RemoveRecordSchedule | ? | Yes | Remove a Recording rule. | Not started | ||
| GetRecordScheduleList | ? | No | Query all configured recording rules, and return them in a list. | Not Started | ||
| GetRecordSchedule | ? | No | Return a single recording rule, by record id. | Not started | ||
| AddRecordSchedule | ? | Yes | Add a single recording rule, by record id. | Not started | ||
| UpdateRecordSchedule | ? | Yes | Update a single recording rule, by record id. | Not started | ||
| EnableRecordSchedule | ? | Yes | Enable a recording schedule, by record id. | Not Started | ||
| DisableRecordSchedule | ? | Yes | Disable a recording schedule, by record id. | Not started | ||
| DeleteRecording | 6.0 | Yes | Delete a recording, by recording id | Not Started | ||
| UnDeleteRecording | 6.0 | Yes | Un-delete a recording, by recording id | Not started | ||
| UpdateRecordedWatchedStatus | 6.0 | Yes | Mark a recording watched, or unwatched, by recording id | Not Started | ||
| StopRecording | 6.3 | No | Stop a current recording, by recording id | Not started | ||
| ReactivateRecording | 6.3 | No | Reactivate a stopped recording, by recording id | Not Started | ||
| RescheduleRecordings | 6.3 | No | Trigger a reschedule | Not started | ||
| RecordedIdForPathname | 6.3 | No | Retrieve the recording id for given a recording file name | Not Started | ||
| GetRecordedMarkup | 7.0 | No | Retrieve the complete markup and seek tables by Recorded Id | Not started | ||
| SetRecordedMarkup | 7.0 | Yes | Set the markup and seek tables for the given Recorded Id | Not Started | ||
| GetRecordedSeek | 6.3 | No | Retrieve the seektable, by recording id and type | Not started | ||
| ManageJobQueue | 6.6 | Yes | Administer User, Commflag and Metadata jobs | 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. | Not started | ||
| SendMessage | No (Yes 0.28+) | Send a message to the frontend, which will appear as a popup message on the screen. | Not Started | ||
| SendNotification | No (Yes 0.28+) | Send a notification to the frontend which will appear in the Notification Center. | Not started | ||
| SendAction | No (Yes 0.28+) | Send an action such as UP, DOWN, SELECT, etc. to the frontend. | Not Started | ||
| GetActionList | No | Get a list of actions which can be performed on the frontend using SendAction. | Not started | ||
| PlayRecording | No (Yes 0.28+) | Play a television recording. | Not Started | ||
| PlayVideo | No (Yes 0.28+) | Play a video. | Not started | ||
| SendKey | Yes (new in 0.28+) | Send a window aware key such as UP, DOWN, SELECT, etc. to the frontend. | Not Started |
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
| API Command | POST Required? | Description | Developer | Status | Notes |
| CreateThumbnail | Yes | TBC | Not started | ||
| GetImageInfo | No | TBC | Not Started | ||
| GetImageInfoList | No | TBC | Not started | ||
| GetSyncStatus | No | TBC. | Not Started | ||
| RemoveImage | Yes | TBC. | Not started | ||
| RenameImage | Yes | TBC. | Not Started | ||
| StartSync | Yes | TBC. | Not started | ||
| StopSync | Yes | TBC. | Not Started |
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
| API Command | POST Required? | Description | Developer | Status | Notes |
| AddStorageGroupDir | Yes | TBD | Not started | ||
| CheckDatabase | Yes | TBD | Not Started | ||
| AddStorageGroupDir | Yes | TBD | Not started | ||
| BackupDatabase | Yes | TBD | Not Started | ||
| GetBackendInfo | No (new in 0.28) | Get basic information about the backend's configuration. | Not started | ||
| GetConnectionInfo | No | TBD | Not Started | ||
| ChangePassword | Yes | TBD | Not started | ||
| GetHostName | No | TBD | Not Started | ||
| GetHosts | No | TBD | Not started | ||
| GetKeys | No | TBD | Not Started | ||
| GetLogs | No | TBD | Not started | ||
| GetSettings | No | Used prior to 0.28 | Not Started | ||
| GetSetting | No | Gets an individual setting in 0.28+ | |||
| GetSettingList | No | Gets a list of settings in 0.28+ | Not Started | ||
| GetStorageGroupDirs | No | TBD | Not started | ||
| GetTimeZone | No | TBD | Not Started | ||
| ManageDigestUser (v30+) | Yes | Add/Remove/ChangePassword for API users | Not started | ||
| ManageUrlProtection (v30+) | Yes | Setup digest protection for none, one or more services | Not Started | ||
| ProfileSubmit | Yes | TBD | |||
| ProfileText | Yes | TBD | Not started | ||
| ProfileURL | Yes | TBD | Not Started | ||
| ProfileUpdated | No | TBD | Not started | ||
| PutSetting | Yes | TBD | Not Started | ||
| RemoveStorageGroupDir | Yes | TBD | Not started | ||
| SendMessage | No (0.28+ Yes) | Send a message to one or more frontends, which will appear as a popup message on the screen. | Not Started | ||
| SendNotification | No (0.28+ Yes) | Send a notification to one or more frontends which will appear in the Notification Center. | Not started | ||
| TestDBSettings | Yes | TBD | Not Started | ||
| DelayShutdown | Yes (new in v31) | Delay backend shutdown for 5 minutes | Not started |
Video Service API List
| API Command | POST Required? | Description | Developer | Status | Notes |
| GetVideoList | No | Get a list of videos and their metadata. | Peter Bennett | Started | |
| GetVideo | No | Get a single video's metadata by database id. | Not 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 |
