API parameters 0.27

From MythTV Official Wiki
Revision as of 18:22, 29 October 2015 by Llib (talk | contribs) (Sample link)

Jump to: navigation, search

This page lists all the service APIs, their type (GET or POST) and their calling parameters in a 0.27 system. The list has been created automatically from wsdl pages.


API routines in 0.27.20141016-1

 Capture/AddCaptureCard             Type:  POST   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   params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,
                                                         ExternalCommand,HostName,InputName,LiveTVOrder,Quicktune,
                                                         RecPriority,SchedOrder,SourceId,StartChan,TuneChan
Capture/GetCaptureCard             Type:  GET    params: CardId
Capture/GetCaptureCardList         Type:  GET    params: CardType,HostName
Capture/RemoveCaptureCard          Type:  POST   params: CardId
Capture/RemoveCardInput            Type:  POST   params: CardInputId
Capture/UpdateCaptureCard          Type:  POST   params: CardId,Setting,Value
Capture/UpdateCardInput            Type:  POST   params: CardInputId,Setting,Value
Channel/AddDBChannel               Type:  POST   params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,
                                                         ChannelName,ChannelNumber,DefaultAuthority,Format,
                                                         FrequencyID,Icon,MplexID,ServiceID,SourceID,
                                                         UseEIT,XMLTVID,visible
Channel/AddVideoSource             Type:  POST   params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,
                                                         SourceName,UseEIT,UserId
Channel/FetchChannelsFromSource    Type:  GET    params: CardId,SourceId,WaitForFinish
Channel/GetChannelInfo             Type:  GET    params: ChanID
Channel/GetChannelInfoList         Type:  GET    params: Count,SourceID,StartIndex
Channel/GetDDLineupList            Type:  GET    params: Password,Source,UserId
Channel/GetVideoMultiplex          Type:  GET    params: MplexID
Channel/GetVideoMultiplexList      Type:  GET    params: Count,SourceID,StartIndex
Channel/GetVideoSource             Type:  GET    params: SourceID
Channel/GetVideoSourceList         Type:  GET    params: (none)
Channel/GetXMLTVIdList             Type:  GET    params: SourceID
Channel/RemoveDBChannel            Type:  POST   params: ChannelID
Channel/RemoveVideoSource          Type:  POST   params: SourceID
Channel/UpdateDBChannel            Type:  POST   params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,
                                                         ChannelName,ChannelNumber,DefaultAuthority,Format,
                                                         FrequencyID,Icon,MplexID,ServiceID,SourceID,UseEIT,
                                                         XMLTVID,visible
Channel/UpdateVideoSource          Type:  POST   params: ConfigPath,FreqTable,Grabber,LineupId,NITId,
                                                         Password,SourceID,SourceName,UseEIT,UserId
Content/AddLiveStream              Type:  GET    params: AudioBitrate,Bitrate,FileName,Height,HostName,MaxSegments,
                                                         SampleRate,StorageGroup,Width
Content/AddRecordingLiveStream     Type:  GET    params: AudioBitrate,Bitrate,ChanId,Height,MaxSegments,SampleRate,
                                                         StartTime,Width
Content/AddVideoLiveStream         Type:  GET    params: AudioBitrate,Bitrate,Height,Id,MaxSegments,SampleRate,Width
Content/DownloadFile               Type:  POST   params: StorageGroup,URL
Content/GetAlbumArt                Type:  GET    params: Height,Id,Width
Content/GetFile                    Type:  GET    params: FileName,StorageGroup
Content/GetFileList                Type:  GET    params: StorageGroup
Content/GetHash                    Type:  GET    params: FileName,StorageGroup
Content/GetImageFile               Type:  GET    params: FileName,Height,StorageGroup,Width
Content/GetLiveStream              Type:  GET    params: Id
Content/GetLiveStreamList          Type:  GET    params: FileName
Content/GetMusic                   Type:  GET    params: Id
Content/GetPreviewImage            Type:  GET    params: ChanId,Height,SecsIn,StartTime,Width
Content/GetProgramArtworkList      Type:  GET    params: Inetref,Season
Content/GetRecording               Type:  GET    params: ChanId,StartTime
Content/GetRecordingArtwork        Type:  GET    params: Height,Inetref,Season,Type,Width
Content/GetRecordingArtworkList    Type:  GET    params: ChanId,StartTime
Content/GetVideo                   Type:  GET    params: Id
Content/GetVideoArtwork            Type:  GET    params: Height,Id,Type,Width
Content/RemoveLiveStream           Type:  GET    params: Id
Content/StopLiveStream             Type:  GET    params: Id
Dvr/AddRecordSchedule              Type:  POST   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/DisableRecordSchedule          Type:  POST   params: RecordId
Dvr/EnableRecordSchedule           Type:  POST   params: RecordId
Dvr/GetConflictList                Type:  GET    params: Count,StartIndex
Dvr/GetEncoderList                 Type:  GET    params: (none)
Dvr/GetExpiringList                Type:  GET    params: Count,StartIndex
Dvr/GetRecGroupList                Type:  GET    params: (none)
Dvr/GetRecordSchedule              Type:  GET    params: ChanId,MakeOverride,RecordId,StartTime,Template
Dvr/GetRecordScheduleList          Type:  GET    params: Count,StartIndex
Dvr/GetRecorded                    Type:  GET    params: ChanId,StartTime
Dvr/GetRecordedList                Type:  GET    params: Count,Descending,RecGroup,StartIndex,StorageGroup,TitleRegEx
Dvr/GetTitleInfoList               Type:  GET    params: (none)
Dvr/GetTitleList                   Type:  GET    params: (none)
Dvr/GetUpcomingList                Type:  GET    params: Count,ShowAll,StartIndex
Dvr/RemoveRecordSchedule           Type:  POST   params: RecordId
Dvr/RemoveRecorded                 Type:  GET    params: ChanId,StartTime
Dvr/UpdateRecordSchedule           Type:  POST   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
Frontend/GetActionList             Type:  GET    params: Context
Frontend/GetContextList            Type:  GET    params: (none)
Frontend/GetStatus                 Type:  GET    params: (none)
Frontend/PlayRecording             Type:  GET    params: ChanId,StartTime
Frontend/PlayVideo                 Type:  GET    params: Id,UseBookmark
Frontend/SendAction                Type:  GET    params: Action,Height,Value,Width
Frontend/SendMessage               Type:  GET    params: Message,Timeout
Frontend/SendNotification          Type:  GET    params: Description,Error,Extra,Fullscreen,Image,Message,
                                                         Origin,Priority,Progress,ProgressText,Timeout,Type,
                                                         Visibility
Guide/GetChannelIcon               Type:  GET    params: ChanId,Height,Width
Guide/GetProgramDetails            Type:  GET    params: ChanId,StartTime
Guide/GetProgramGuide              Type:  GET    params: Details,EndTime,NumChannels,StartChanId,StartTime
Video/AddVideo                     Type:  POST   params: FileName,HostName
Video/GetBluray                    Type:  GET    params: Path
Video/GetVideo                     Type:  GET    params: Id
Video/GetVideoByFileName           Type:  GET    params: FileName
Video/GetVideoList                 Type:  GET    params: Count,Descending,StartIndex
Video/LookupVideo                  Type:  GET    params: AllowGeneric,Episode,GrabberType,Inetref,Season,
                                                         Subtitle,Title
Video/RemoveVideoFromDB            Type:  POST   params: Id