API parameters 0.28
From MythTV Official Wiki
This is a full list of API calls, their types (POST or GET), the change status since 0.27.20141016-1, and the input parameters. This page has been generated automatically by analysing the output of wsdl calls from a 0.28 pre-release system.
Note that:
a) Responses are neither listed nor compared
b) There may be further changes before full release of 0.28.
API routines in 0.28.20150906-1
Capture/AddCaptureCard type: POST Status: same as 0.27 Params: AudioDevice,AudioRateLimit,Brightness,CardType,ChannelTimeout, Colour,Contrast,DVBDiSEqCType,DVBEITScan,DVBOnDemand,DVBSWFilter, DVBSatType,DVBTuningDelay,DVBWaitForSeqStart,DiSEqCId,FirewireConnection, FirewireModel,FirewireSpeed,HostName,Hue,SignalTimeout,SkipBTAudio, VBIDevice,VideoDevice
Capture/AddCardInput type: POST Status: same as 0.27 Params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,ExternalCommand, HostName,InputName,LiveTVOrder,Quicktune,RecPriority,SchedOrder, SourceId,StartChan,TuneChan
Capture/GetCaptureCard type: GET Status: same as 0.27 Params: CardId
Capture/GetCaptureCardList type: GET Status: same as 0.27 Params: CardType,HostName
Capture/RemoveCaptureCard type: POST Status: same as 0.27 Params: CardId
Capture/RemoveCardInput type: POST Status: same as 0.27 Params: CardInputId
Capture/UpdateCaptureCard type: POST Status: same as 0.27 Params: CardId,Setting,Value
Capture/UpdateCardInput type: POST Status: same as 0.27 Params: CardInputId,Setting,Value
Channel/AddDBChannel type: POST Status: changed since 0.27 Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName, ChannelNumber,DefaultAuthority,Format,FrequencyID,Icon,MplexID, ServiceID,SourceID,UseEIT,Visible,XMLTVID
Channel/AddVideoSource type: POST Status: same as 0.27 Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceName, UseEIT,UserId
Channel/FetchChannelsFromSource type: GET Status: same as 0.27 Params: CardId,SourceId,WaitForFinish
Channel/GetChannelInfo type: GET Status: same as 0.27 Params: ChanID
Channel/GetChannelInfoList type: GET Status: changed since 0.27 Params: Count,Details,OnlyVisible,SourceID,StartIndex
Channel/GetDDLineupList type: GET Status: same as 0.27 Params: Password,Source,UserId
Channel/GetVideoMultiplex type: GET Status: same as 0.27 Params: MplexID
Channel/GetVideoMultiplexList type: GET Status: same as 0.27 Params: Count,SourceID,StartIndex
Channel/GetVideoSource type: GET Status: same as 0.27 Params: SourceID
Channel/GetVideoSourceList type: GET Status: same as 0.27 Params: (none)
Channel/GetXMLTVIdList type: GET Status: same as 0.27 Params: SourceID
Channel/RemoveDBChannel type: POST Status: same as 0.27 Params: ChannelID
Channel/RemoveVideoSource type: POST Status: same as 0.27 Params: SourceID
Channel/UpdateDBChannel type: POST Status: changed since 0.27 Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName, ChannelNumber,DefaultAuthority,Format,FrequencyID,Icon,MplexID, ServiceID,SourceID,UseEIT,Visible,XMLTVID
Channel/UpdateVideoSource type: POST Status: same as 0.27 Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceID, SourceName,UseEIT,UserId
Content/AddLiveStream type: GET Status: same as 0.27 Params: AudioBitrate,Bitrate,FileName,Height,HostName,MaxSegments,SampleRate, StorageGroup,Width
Content/AddRecordingLiveStream type: GET Status: changed since 0.27 Params: AudioBitrate,Bitrate,ChanId,Height,MaxSegments,RecordedId,SampleRate, StartTime,Width
Content/AddVideoLiveStream type: GET Status: same as 0.27 Params: AudioBitrate,Bitrate,Height,Id,MaxSegments,SampleRate,Width
Content/DownloadFile type: POST Status: same as 0.27 Params: StorageGroup,URL
Content/GetAlbumArt type: GET Status: same as 0.27 Params: Height,Id,Width
Content/GetDirList type: GET Status: new since 0.27 Params: StorageGroup
Content/GetFile type: GET Status: same as 0.27 Params: FileName,StorageGroup
Content/GetFileList type: GET Status: same as 0.27 Params: StorageGroup
Content/GetHash type: GET Status: same as 0.27 Params: FileName,StorageGroup
Content/GetImageFile type: GET Status: same as 0.27 Params: FileName,Height,StorageGroup,Width
Content/GetLiveStream type: GET Status: same as 0.27 Params: Id
Content/GetLiveStreamList type: GET Status: same as 0.27 Params: FileName
Content/GetMusic type: GET Status: same as 0.27 Params: Id
Content/GetPreviewImage type: GET Status: changed since 0.27 Params: ChanId,Format,Height,RecordedId,SecsIn,StartTime,Width
Content/GetProgramArtworkList type: GET Status: same as 0.27 Params: Inetref,Season
Content/GetRecording type: GET Status: changed since 0.27 Params: ChanId,RecordedId,StartTime
Content/GetRecordingArtwork type: GET Status: same as 0.27 Params: Height,Inetref,Season,Type,Width
Content/GetRecordingArtworkList type: GET Status: changed since 0.27 Params: ChanId,RecordedId,StartTime
Content/GetVideo type: GET Status: same as 0.27 Params: Id
Content/GetVideoArtwork type: GET Status: same as 0.27 Params: Height,Id,Type,Width
Content/RemoveLiveStream type: GET Status: same as 0.27 Params: Id
Content/StopLiveStream type: GET Status: same as 0.27 Params: Id
Dvr/AddDontRecordSchedule type: GET Status: new since 0.27 Params: ChanId,NeverRecord,StartTime
Dvr/AddRecordSchedule type: POST Status: same as 0.27 Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1, AutoUserJob2,AutoUserJob3,AutoUserJob4,Category,ChanId,Description, DupIn,DupMethod,EndOffset,EndTime,Episode,Filter,FindDay,FindTime, Inactive,Inetref,MaxEpisodes,MaxNewest,ParentId,PlayGroup,PreferredInput, ProgramId,RecGroup,RecPriority,RecProfile,SearchType,Season,SeriesId, StartOffset,StartTime,Station,StorageGroup,Subtitle,Title,Transcoder, Type
Dvr/DeleteRecording type: POST Status: new since 0.27 Params: AllowRerecord,ChanId,ForceDelete,RecordedId,StartTime
Dvr/DisableRecordSchedule type: POST Status: same as 0.27 Params: RecordId
Dvr/DupInToDescription type: GET Status: new since 0.27 Params: DupIn
Dvr/DupInToString type: GET Status: new since 0.27 Params: DupIn
Dvr/DupMethodToDescription type: GET Status: new since 0.27 Params: DupMethod
Dvr/DupMethodToString type: GET Status: new since 0.27 Params: DupMethod
Dvr/EnableRecordSchedule type: POST Status: same as 0.27 Params: RecordId
Dvr/GetConflictList type: GET Status: changed since 0.27 Params: Count,RecordId,StartIndex
Dvr/GetEncoderList type: GET Status: same as 0.27 Params: (none)
Dvr/GetExpiringList type: GET Status: same as 0.27 Params: Count,StartIndex
Dvr/GetInputList type: GET Status: new since 0.27 Params: (none)
Dvr/GetPlayGroupList type: GET Status: new since 0.27 Params: (none)
Dvr/GetRecGroupList type: GET Status: same as 0.27 Params: (none)
Dvr/GetRecRuleFilterList type: GET Status: new since 0.27 Params: (none)
Dvr/GetRecStorageGroupList type: GET Status: new since 0.27 Params: (none)
Dvr/GetRecordSchedule type: GET Status: changed since 0.27 Params: ChanId,MakeOverride,RecordId,RecordedId,StartTime,Template
Dvr/GetRecordScheduleList type: GET Status: changed since 0.27 Params: Count,Descending,Sort,StartIndex
Dvr/GetRecorded type: GET Status: changed since 0.27 Params: ChanId,RecordedId,StartTime
Dvr/GetRecordedCommBreak type: GET Status: new since 0.27 Params: ChanId,OffsetType,RecordedId,StartTime
Dvr/GetRecordedCutList type: GET Status: new since 0.27 Params: ChanId,OffsetType,RecordedId,StartTime
Dvr/GetRecordedList type: GET Status: same as 0.27 Params: Count,Descending,RecGroup,StartIndex,StorageGroup,TitleRegEx
Dvr/GetTitleInfoList type: GET Status: same as 0.27 Params: (none)
Dvr/GetTitleList type: GET Status: changed since 0.27 Params: RecGroup
Dvr/GetUpcomingList type: GET Status: changed since 0.27 Params: Count,RecStatus,RecordId,ShowAll,StartIndex
Dvr/RecStatusToDescription type: GET Status: new since 0.27 Params: RecStatus,RecType,StartTime
Dvr/RecStatusToString type: GET Status: new since 0.27 Params: RecStatus
Dvr/RecTypeToDescription type: GET Status: new since 0.27 Params: RecType
Dvr/RecTypeToString type: GET Status: new since 0.27 Params: RecType
Dvr/RemoveRecordSchedule type: POST Status: same as 0.27 Params: RecordId
Dvr/RemoveRecorded type: POST Status: changed since 0.27 Params: AllowRerecord,ChanId,ForceDelete,RecordedId,StartTime
Dvr/UnDeleteRecording type: GET Status: new since 0.27 Params: ChanId,RecordedId,StartTime
Dvr/UpdateRecordSchedule type: POST Status: same as 0.27 Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1, AutoUserJob2,AutoUserJob3,AutoUserJob4,Category,ChanId,Description, DupIn,DupMethod,EndOffset,EndTime,Episode,Filter,FindDay,FindTime, Inactive,Inetref,MaxEpisodes,MaxNewest,PlayGroup,PreferredInput, ProgramId,RecGroup,RecPriority,RecProfile,RecordId,SearchType, Season,SeriesId,StartOffset,StartTime,Station,StorageGroup,Subtitle, Title,Transcoder,Type
Dvr/UpdateRecordedWatchedStatus type: POST Status: new since 0.27 Params: ChanId,RecordedId,StartTime,Watched
Frontend/GetActionList type: GET Status: same as 0.27 Params: Context
Frontend/GetContextList type: GET Status: same as 0.27 Params: (none)
Frontend/GetStatus type: GET Status: same as 0.27 Params: (none)
Frontend/PlayRecording type: POST Status: changed since 0.27 Params: ChanId,RecordedId,StartTime
Frontend/PlayVideo type: POST Status: changed since 0.27 Params: Id,UseBookmark
Frontend/SendAction type: POST Status: changed since 0.27 Params: Action,Height,Value,Width
Frontend/SendMessage type: POST Status: changed since 0.27 Params: Message,Timeout
Frontend/SendNotification type: POST Status: changed since 0.27 Params: Description,Error,Extra,Fullscreen,Image,Message,Origin,Priority, Progress,ProgressText,Timeout,Type,Visibility
Guide/GetCategoryList type: GET Status: new since 0.27 Params: (none)
Guide/GetChannelGroupList type: GET Status: new since 0.27 Params: IncludeEmpty
Guide/GetChannelIcon type: GET Status: same as 0.27 Params: ChanId,Height,Width
Guide/GetProgramDetails type: GET Status: same as 0.27 Params: ChanId,StartTime
Guide/GetProgramGuide type: GET Status: changed since 0.27 Params: ChannelGroupId,Count,Details,EndTime,StartIndex,StartTime
Guide/GetProgramList type: GET Status: new since 0.27 Params: CategoryFilter,ChanId,Count,Descending,Details,EndTime,KeywordFilter, OnlyNew,PersonFilter,Sort,StartIndex,StartTime,TitleFilter
Guide/GetStoredSearches type: GET Status: new since 0.27 Params: Type
Video/AddVideo type: POST Status: same as 0.27 Params: FileName,HostName
Video/GetBluray type: GET Status: same as 0.27 Params: Path
Video/GetVideo type: GET Status: same as 0.27 Params: Id
Video/GetVideoByFileName type: GET Status: same as 0.27 Params: FileName
Video/GetVideoList type: GET Status: changed since 0.27 Params: Count,Descending,Folder,Sort,StartIndex
Video/LookupVideo type: GET Status: same as 0.27 Params: AllowGeneric,Episode,GrabberType,Inetref,Season,Subtitle,Title Video/RemoveVideoFromDB type: POST Status: same as 0.27 Params: Id
Video/UpdateVideoWatchedStatus type: POST Status: new since 0.27 Params: Id,Watched