Difference between revisions of "API parameters 0.27"

From MythTV Official Wiki
Jump to: navigation, search
m (Example with the 1st 2)
m (Added link to page generator)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
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.
+
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 generated automatically from wsdl pages.  See [[API documentation generator]].
  
  
−
API routines in 0.27.20141016-1
 
  
−
   [[Capture_Service|Capture]]/AddCaptureCard             Type: POST  params: AudioDevice,AudioRateLimit,Brightness,CardType,ChannelTimeout,
+
 
−
                                                        Colour,Contrast,DVBDiSEqCType,DVBEITScan,
+
 
−
                                                        DVBOnDemand,DVBSWFilter,DVBSatType,DVBTuningDelay,
+
==API routines in 0.27.20141016-1==
−
                                                        DVBWaitForSeqStart,DiSEqCId,FirewireConnection,FirewireModel,
+
====Capture  service====
−
                                                        FirewireSpeed,HostName,Hue,SignalTimeout,SkipBTAudio,
+
   [[Capture_Service#AddCaptureCard|Capture/AddCaptureCard]]            type: POST
−
                                                        VBIDevice,VideoDevice
+
 
−
   [[Capture_Service|Capture]]/AddCardInput               Type: POST  params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,
+
   Params: AudioDevice, AudioRateLimit, Brightness, CardType, ChannelTimeout,  
−
                                                        ExternalCommand,HostName,InputName,LiveTVOrder,Quicktune,
+
          Colour, Contrast, DVBDiSEqCType, DVBEITScan, DVBOnDemand, DVBSWFilter,  
−
                                                        RecPriority,SchedOrder,SourceId,StartChan,TuneChan
+
          DVBSatType, DVBTuningDelay, DVBWaitForSeqStart, DiSEqCId, FirewireConnection,  
−
<pre>
+
          FirewireModel, FirewireSpeed, HostName, Hue, SignalTimeout, SkipBTAudio,  
−
Capture/GetCaptureCard            Type: GET   params: CardId
+
          VBIDevice, VideoDevice
−
Capture/GetCaptureCardList        Type: GET   params: CardType,HostName
+
 
−
Capture/RemoveCaptureCard          Type: POST  params: CardId
+
   [[Capture_Service#AddCardInput|Capture/AddCardInput]]              type: POST
−
Capture/RemoveCardInput            Type: POST  params: CardInputId
+
 
−
Capture/UpdateCaptureCard          Type: POST  params: CardId,Setting,Value
+
   Params: CardId, ChangerDevice, ChangerModel, DishnetEIT, DisplayName,  
−
Capture/UpdateCardInput            Type: POST  params: CardInputId,Setting,Value
+
          ExternalCommand, HostName, InputName, LiveTVOrder, Quicktune,  
−
Channel/AddDBChannel              Type: POST  params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,
+
          RecPriority, SchedOrder, SourceId, StartChan, TuneChan
−
                                                        ChannelName,ChannelNumber,DefaultAuthority,Format,
+
 
−
                                                        FrequencyID,Icon,MplexID,ServiceID,SourceID,
+
  [[Capture_Service#GetCaptureCard|Capture/GetCaptureCard]]             type: GET  
−
                                                        UseEIT,XMLTVID,visible
+
 
−
Channel/AddVideoSource            Type: POST  params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,
+
  Params: CardId
−
                                                        SourceName,UseEIT,UserId
+
 
−
Channel/FetchChannelsFromSource    Type: GET   params: CardId,SourceId,WaitForFinish
+
  [[Capture_Service#GetCaptureCardList|Capture/GetCaptureCardList]]         type: GET  
−
Channel/GetChannelInfo            Type: GET   params: ChanID
+
 
−
Channel/GetChannelInfoList        Type: GET   params: Count,SourceID,StartIndex
+
  Params: CardType, HostName
−
Channel/GetDDLineupList            Type: GET   params: Password,Source,UserId
+
 
−
Channel/GetVideoMultiplex          Type: GET   params: MplexID
+
  [[Capture_Service#RemoveCaptureCard|Capture/RemoveCaptureCard]]         type: POST
−
Channel/GetVideoMultiplexList      Type: GET   params: Count,SourceID,StartIndex
+
 
−
Channel/GetVideoSource            Type: GET   params: SourceID
+
   Params: CardId
−
Channel/GetVideoSourceList        Type: GET   params: (none)
+
 
−
Channel/GetXMLTVIdList            Type: GET   params: SourceID
+
  [[Capture_Service#RemoveCardInput|Capture/RemoveCardInput]]           type: POST
−
Channel/RemoveDBChannel            Type: POST  params: ChannelID
+
 
−
Channel/RemoveVideoSource          Type: POST  params: SourceID
+
   Params: CardInputId
−
Channel/UpdateDBChannel            Type: POST  params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,
+
 
−
                                                        ChannelName,ChannelNumber,DefaultAuthority,Format,
+
  [[Capture_Service#UpdateCaptureCard|Capture/UpdateCaptureCard]]         type: POST
−
                                                        FrequencyID,Icon,MplexID,ServiceID,SourceID,UseEIT,
+
    
−
                                                        XMLTVID,visible
+
  Params: CardId, Setting, Value
−
Channel/UpdateVideoSource          Type: POST  params: ConfigPath,FreqTable,Grabber,LineupId,NITId,
+
 
−
                                                        Password,SourceID,SourceName,UseEIT,UserId
+
  [[Capture_Service#UpdateCardInput|Capture/UpdateCardInput]]           type: POST
−
Content/AddLiveStream              Type: GET   params: AudioBitrate,Bitrate,FileName,Height,HostName,MaxSegments,
+
    
−
                                                        SampleRate,StorageGroup,Width
+
  Params: CardInputId, Setting, Value
−
Content/AddRecordingLiveStream    Type: GET   params: AudioBitrate,Bitrate,ChanId,Height,MaxSegments,SampleRate,
+
 
−
                                                        StartTime,Width
+
====Channel  service====
−
Content/AddVideoLiveStream        Type: GET   params: AudioBitrate,Bitrate,Height,Id,MaxSegments,SampleRate,Width
+
  [[Channel_Service#AddDBChannel|Channel/AddDBChannel]]               type: POST
−
Content/DownloadFile              Type: POST  params: StorageGroup,URL
+
    
−
Content/GetAlbumArt                Type: GET   params: Height,Id,Width
+
  Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName,  
−
Content/GetFile                    Type: GET   params: FileName,StorageGroup
+
          ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID,  
−
Content/GetFileList                Type: GET   params: StorageGroup
+
          ServiceID, SourceID, UseEIT, XMLTVID, visible
−
Content/GetHash                    Type: GET   params: FileName,StorageGroup
+
 
−
Content/GetImageFile              Type: GET   params: FileName,Height,StorageGroup,Width
+
  [[Channel_Service#AddVideoSource|Channel/AddVideoSource]]             type: POST
−
Content/GetLiveStream              Type: GET   params: Id
+
 
−
Content/GetLiveStreamList          Type: GET   params: FileName
+
   Params: ConfigPath, FreqTable, Grabber, LineupId, NITId, Password, SourceName,  
−
Content/GetMusic                  Type: GET   params: Id
+
          UseEIT, UserId
−
Content/GetPreviewImage            Type: GET   params: ChanId,Height,SecsIn,StartTime,Width
+
 
−
Content/GetProgramArtworkList      Type: GET   params: Inetref,Season
+
  [[Channel_Service#FetchChannelsFromSource|Channel/FetchChannelsFromSource]]   type: GET  
−
Content/GetRecording              Type: GET   params: ChanId,StartTime
+
 
−
Content/GetRecordingArtwork        Type: GET   params: Height,Inetref,Season,Type,Width
+
  Params: CardId, SourceId, WaitForFinish
−
Content/GetRecordingArtworkList    Type: GET   params: ChanId,StartTime
+
 
−
Content/GetVideo                  Type: GET   params: Id
+
  [[Channel_Service#GetChannelInfo|Channel/GetChannelInfo]]             type: GET  
−
Content/GetVideoArtwork            Type: GET   params: Height,Id,Type,Width
+
 
−
Content/RemoveLiveStream          Type: GET   params: Id
+
  Params: ChanID
−
Content/StopLiveStream            Type: GET   params: Id
+
 
−
Dvr/AddRecordSchedule              Type: POST  params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,
+
  [[Channel_Service#GetChannelInfoList|Channel/GetChannelInfoList]]         type: GET  
−
                                                        AutoUserJob1,AutoUserJob2,AutoUserJob3,AutoUserJob4,
+
 
−
                                                        Category,ChanId,Description,DupIn,DupMethod,EndOffset,
+
  Params: Count, SourceID, StartIndex
−
                                                        EndTime,Episode,Filter,FindDay,FindTime,Inactive,Inetref,
+
 
−
                                                        MaxEpisodes,MaxNewest,ParentId,PlayGroup,PreferredInput,
+
  [[Channel_Service#GetDDLineupList|Channel/GetDDLineupList]]           type: GET  
−
                                                        ProgramId,RecGroup,RecPriority,RecProfile,SearchType,
+
 
−
                                                        Season,SeriesId,StartOffset,StartTime,Station,
+
  Params: Password, Source, UserId
−
                                                        StorageGroup,Subtitle,Title,Transcoder,Type
+
 
−
Dvr/DisableRecordSchedule          Type: POST  params: RecordId
+
  [[Channel_Service#GetVideoMultiplex|Channel/GetVideoMultiplex]]         type: GET  
−
Dvr/EnableRecordSchedule          Type: POST  params: RecordId
+
 
−
Dvr/GetConflictList                Type: GET   params: Count,StartIndex
+
  Params: MplexID
−
Dvr/GetEncoderList                Type: GET   params: (none)
+
 
−
Dvr/GetExpiringList                Type: GET   params: Count,StartIndex
+
  [[Channel_Service#GetVideoMultiplexList|Channel/GetVideoMultiplexList]]     type: GET  
−
Dvr/GetRecGroupList                Type: GET   params: (none)
+
 
−
Dvr/GetRecordSchedule              Type: GET   params: ChanId,MakeOverride,RecordId,StartTime,Template
+
  Params: Count, SourceID, StartIndex
−
Dvr/GetRecordScheduleList          Type: GET   params: Count,StartIndex
+
 
−
Dvr/GetRecorded                    Type: GET   params: ChanId,StartTime
+
  [[Channel_Service#GetVideoSource|Channel/GetVideoSource]]             type: GET  
−
Dvr/GetRecordedList                Type: GET   params: Count,Descending,RecGroup,StartIndex,StorageGroup,TitleRegEx
+
 
−
Dvr/GetTitleInfoList              Type: GET   params: (none)
+
  Params: SourceID
−
Dvr/GetTitleList                  Type: GET   params: (none)
+
 
−
Dvr/GetUpcomingList                Type: GET   params: Count,ShowAll,StartIndex
+
  [[Channel_Service#GetVideoSourceList|Channel/GetVideoSourceList]]         type: GET  
−
Dvr/RemoveRecordSchedule          Type: POST  params: RecordId
+
 
−
Dvr/RemoveRecorded                Type: GET   params: ChanId,StartTime
+
    Params: (none)
−
Dvr/UpdateRecordSchedule          Type: POST  params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,
+
 
−
                                                        AutoUserJob1,AutoUserJob2,AutoUserJob3,AutoUserJob4,
+
  [[Channel_Service#GetXMLTVIdList|Channel/GetXMLTVIdList]]             type: GET  
−
                                                        Category,ChanId,Description,DupIn,DupMethod,EndOffset,
+
 
−
                                                        EndTime,Episode,Filter,FindDay,FindTime,Inactive,Inetref,
+
  Params: SourceID
−
                                                        MaxEpisodes,MaxNewest,PlayGroup,PreferredInput,ProgramId,
+
 
−
                                                        RecGroup,RecPriority,RecProfile,RecordId,SearchType,Season,
+
  [[Channel_Service#RemoveDBChannel|Channel/RemoveDBChannel]]           type: POST
−
                                                        SeriesId,StartOffset,StartTime,Station,StorageGroup,Subtitle,
+
 
−
                                                        Title,Transcoder,Type
+
   Params: ChannelID
−
Frontend/GetActionList            Type: GET   params: Context
+
 
−
Frontend/GetContextList            Type: GET   params: (none)
+
  [[Channel_Service#RemoveVideoSource|Channel/RemoveVideoSource]]         type: POST
−
Frontend/GetStatus                Type: GET   params: (none)
+
 
−
Frontend/PlayRecording            Type: GET   params: ChanId,StartTime
+
   Params: SourceID
−
Frontend/PlayVideo                Type: GET   params: Id,UseBookmark
+
 
−
Frontend/SendAction                Type: GET   params: Action,Height,Value,Width
+
  [[Channel_Service#UpdateDBChannel|Channel/UpdateDBChannel]]           type: POST
−
Frontend/SendMessage              Type: GET   params: Message,Timeout
+
    
−
Frontend/SendNotification          Type: GET   params: Description,Error,Extra,Fullscreen,Image,Message,
+
  Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName,  
−
                                                        Origin,Priority,Progress,ProgressText,Timeout,Type,
+
          ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID,  
−
                                                        Visibility
+
          ServiceID, SourceID, UseEIT, XMLTVID, visible
−
Guide/GetChannelIcon              Type: GET   params: ChanId,Height,Width
+
 
−
Guide/GetProgramDetails            Type: GET   params: ChanId,StartTime
+
  [[Channel_Service#UpdateVideoSource|Channel/UpdateVideoSource]]         type: POST
−
Guide/GetProgramGuide              Type: GET   params: Details,EndTime,NumChannels,StartChanId,StartTime
+
    
−
Video/AddVideo                    Type: POST  params: FileName,HostName
+
  Params: ConfigPath, FreqTable, Grabber, LineupId, NITId, Password, SourceID,  
−
Video/GetBluray                    Type: GET    params: Path
+
          SourceName, UseEIT, UserId
−
Video/GetVideo                    Type:  GET    params: Id
+
 
−
Video/GetVideoByFileName          Type: GET    params: FileName
+
====Content  service====
−
Video/GetVideoList                 Type: GET    params: Count,Descending,StartIndex
+
  [[Content_Service#AddLiveStream|Content/AddLiveStream]]             type: GET  
−
Video/LookupVideo                  Type: GET   params: AllowGeneric,Episode,GrabberType,Inetref,Season,
+
 
−
                                                        Subtitle,Title
+
  Params: AudioBitrate, Bitrate, FileName, Height, HostName, MaxSegments,  
−
Video/RemoveVideoFromDB            Type: POST   params: Id
+
          SampleRate, StorageGroup, Width
−
</pre>
+
 
 +
  [[Content_Service#AddRecordingLiveStream|Content/AddRecordingLiveStream]]     type: GET  
 +
 
 +
  Params: AudioBitrate, Bitrate, ChanId, Height, MaxSegments, SampleRate,  
 +
          StartTime, Width
 +
 
 +
  [[Content_Service#AddVideoLiveStream|Content/AddVideoLiveStream]]         type: GET  
 +
 
 +
  Params: AudioBitrate, Bitrate, Height, Id, MaxSegments, SampleRate, Width
 +
 
 +
  [[Content_Service#DownloadFile|Content/DownloadFile]]               type: POST
 +
 
 +
   Params: StorageGroup, URL
 +
 
 +
  [[Content_Service#GetAlbumArt|Content/GetAlbumArt]]               type: GET  
 +
 
 +
  Params: Height, Id, Width
 +
 
 +
  [[Content_Service#GetFile|Content/GetFile]]                   type: GET  
 +
 
 +
  Params: FileName, StorageGroup
 +
 
 +
  [[Content_Service#GetFileList|Content/GetFileList]]               type: GET  
 +
 
 +
  Params: StorageGroup
 +
 
 +
  [[Content_Service#GetHash|Content/GetHash]]                   type: GET  
 +
 
 +
  Params: FileName, StorageGroup
 +
 
 +
  [[Content_Service#GetImageFile|Content/GetImageFile]]               type: GET  
 +
 
 +
  Params: FileName, Height, StorageGroup, Width
 +
 
 +
  [[Content_Service#GetLiveStream|Content/GetLiveStream]]             type: GET  
 +
 
 +
  Params: Id
 +
 
 +
  [[Content_Service#GetLiveStreamList|Content/GetLiveStreamList]]         type: GET  
 +
 
 +
  Params: FileName
 +
 
 +
  [[Content_Service#GetMusic|Content/GetMusic]]                   type: GET  
 +
 
 +
  Params: Id
 +
 
 +
  [[Content_Service#GetPreviewImage|Content/GetPreviewImage]]           type: GET  
 +
 
 +
  Params: ChanId, Height, SecsIn, StartTime, Width
 +
 
 +
  [[Content_Service#GetProgramArtworkList|Content/GetProgramArtworkList]]     type: GET  
 +
 
 +
  Params: Inetref, Season
 +
 
 +
  [[Content_Service#GetRecording|Content/GetRecording]]               type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[Content_Service#GetRecordingArtwork|Content/GetRecordingArtwork]]       type: GET  
 +
 
 +
  Params: Height, Inetref, Season, Type, Width
 +
 
 +
  [[Content_Service#GetRecordingArtworkList|Content/GetRecordingArtworkList]]   type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[Content_Service#GetVideo|Content/GetVideo]]                   type: GET  
 +
 
 +
  Params: Id
 +
 
 +
  [[Content_Service#GetVideoArtwork|Content/GetVideoArtwork]]           type: GET  
 +
 
 +
  Params: Height, Id, Type, Width
 +
 
 +
  [[Content_Service#RemoveLiveStream|Content/RemoveLiveStream]]           type: GET  
 +
 
 +
  Params: Id
 +
 
 +
  [[Content_Service#StopLiveStream|Content/StopLiveStream]]             type: GET  
 +
 
 +
  Params: Id
 +
 
 +
====Dvr  service====
 +
  [[DVR_Service#AddRecordSchedule|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_Service#DisableRecordSchedule|Dvr/DisableRecordSchedule]]         type: POST
 +
 
 +
   Params: RecordId
 +
 
 +
  [[DVR_Service#EnableRecordSchedule|Dvr/EnableRecordSchedule]]           type: POST
 +
 
 +
   Params: RecordId
 +
 
 +
  [[DVR_Service#GetConflictList|Dvr/GetConflictList]]               type: GET  
 +
 
 +
  Params: Count, StartIndex
 +
 
 +
  [[DVR_Service#GetEncoderList|Dvr/GetEncoderList]]                 type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[DVR_Service#GetExpiringList|Dvr/GetExpiringList]]               type: GET  
 +
 
 +
  Params: Count, StartIndex
 +
 
 +
  [[DVR_Service#GetRecGroupList|Dvr/GetRecGroupList]]               type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[DVR_Service#GetRecordSchedule|Dvr/GetRecordSchedule]]             type: GET  
 +
 
 +
  Params: ChanId, MakeOverride, RecordId, StartTime, Template
 +
 
 +
  [[DVR_Service#GetRecordScheduleList|Dvr/GetRecordScheduleList]]         type: GET  
 +
 
 +
  Params: Count, StartIndex
 +
 
 +
  [[DVR_Service#GetRecorded|Dvr/GetRecorded]]                   type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[DVR_Service#GetRecordedList|Dvr/GetRecordedList]]               type: GET  
 +
 
 +
  Params: Count, Descending, RecGroup, StartIndex, StorageGroup, TitleRegEx
 +
 
 +
  [[DVR_Service#GetTitleInfoList|Dvr/GetTitleInfoList]]               type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[DVR_Service#GetTitleList|Dvr/GetTitleList]]                   type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[DVR_Service#GetUpcomingList|Dvr/GetUpcomingList]]               type: GET  
 +
 
 +
  Params: Count, ShowAll, StartIndex
 +
 
 +
  [[DVR_Service#RemoveRecordSchedule|Dvr/RemoveRecordSchedule]]           type: POST
 +
    
 +
  Params: RecordId
 +
 
 +
  [[DVR_Service#RemoveRecorded|Dvr/RemoveRecorded]]                 type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[DVR_Service#UpdateRecordSchedule|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  service====
 +
  [[Frontend_Service#GetActionList|Frontend/GetActionList]]             type: GET  
 +
 
 +
  Params: Context
 +
 
 +
  [[Frontend_Service#GetContextList|Frontend/GetContextList]]           type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[Frontend_Service#GetStatus|Frontend/GetStatus]]                 type: GET  
 +
 
 +
    Params: (none)
 +
 
 +
  [[Frontend_Service#PlayRecording|Frontend/PlayRecording]]             type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[Frontend_Service#PlayVideo|Frontend/PlayVideo]]                 type: GET  
 +
 
 +
  Params: Id, UseBookmark
 +
 
 +
  [[Frontend_Service#SendAction|Frontend/SendAction]]               type: GET  
 +
 
 +
  Params: Action, Height, Value, Width
 +
 
 +
  [[Frontend_Service#SendMessage|Frontend/SendMessage]]               type: GET  
 +
 
 +
  Params: Message, Timeout
 +
 
 +
  [[Frontend_Service#SendNotification|Frontend/SendNotification]]         type: GET  
 +
 
 +
  Params: Description, Error, Extra, Fullscreen, Image, Message, Origin,  
 +
          Priority, Progress, ProgressText, Timeout, Type, Visibility
 +
 
 +
====Guide  service====
 +
  [[Guide_Service#GetChannelIcon|Guide/GetChannelIcon]]               type: GET  
 +
 
 +
  Params: ChanId, Height, Width
 +
 
 +
  [[Guide_Service#GetProgramDetails|Guide/GetProgramDetails]]           type: GET  
 +
 
 +
  Params: ChanId, StartTime
 +
 
 +
  [[Guide_Service#GetProgramGuide|Guide/GetProgramGuide]]             type: GET  
 +
 
 +
  Params: Details, EndTime, NumChannels, StartChanId, StartTime
 +
 
 +
====Myth  service====
 +
  [[Myth_Service#AddStorageGroupDir|Myth/AddStorageGroupDir]]            type: POST
 +
    
 +
  Params: DirName, GroupName, HostName
 +
 
 +
  [[Myth_Service#BackupDatabase|Myth/BackupDatabase]]                type: POST
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ChangePassword|Myth/ChangePassword]]                type: POST
 +
 
 +
  Params: NewPassword, OldPassword, UserName
 +
 
 +
  [[Myth_Service#CheckDatabase|Myth/CheckDatabase]]                 type: POST
 +
 
 +
  Params: Repair
 +
 
 +
  [[Myth_Service#GetConnectionInfo|Myth/GetConnectionInfo]]            type: GET  
 +
 
 +
  Params: Pin
 +
 
 +
  [[Myth_Service#GetHostName|Myth/GetHostName]]                  type: GET
 +
    
 +
    Params: (none)
 +
 
 +
  [[Myth_Service#GetHosts|Myth/GetHosts]]                      type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#GetKeys|Myth/GetKeys]]                      type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#GetLogs|Myth/GetLogs]]                      type: GET
 +
 
 +
  Params: Application, Filename, FromTime, Function, HostName, Level, Line,
 +
          MsgContains, PID, TID, Thread, ToTime
 +
 
 +
  [[Myth_Service#GetSetting|Myth/GetSetting]]                    type: GET
 +
 
 +
  Params: Default, HostName, Key
 +
 
 +
  [[Myth_Service#GetStorageGroupDirs|Myth/GetStorageGroupDirs]]          type: GET
 +
 
 +
  Params: GroupName, HostName
 +
 
 +
  [[Myth_Service#GetTimeZone|Myth/GetTimeZone]]                  type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ProfileDelete|Myth/ProfileDelete]]                type: POST
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ProfileSubmit|Myth/ProfileSubmit]]                type: POST
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ProfileText|Myth/ProfileText]]                  type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ProfileURL|Myth/ProfileURL]]                    type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#ProfileUpdated|Myth/ProfileUpdated]]                type: GET
 +
 
 +
    Params:  (none)
 +
 
 +
  [[Myth_Service#PutSetting|Myth/PutSetting]]                    type: POST
 +
 
 +
  Params: HostName, Key, Value
 +
 
 +
  [[Myth_Service#RemoveStorageGroupDir|Myth/RemoveStorageGroupDir]]        type: POST
 +
 
 +
  Params: DirName, GroupName, HostName
 +
 
 +
  [[Myth_Service#SendMessage|Myth/SendMessage]]                  type: GET
 +
 
 +
  Params: Address, Message, Timeout, udpPort
 +
 
 +
  [[Myth_Service#SendNotification|Myth/SendNotification]]              type: GET
 +
 
 +
  Params: Address, Description, Error, Extra, Fullscreen, Image, Message,
 +
          Origin, Priority, Progress, ProgressText, Timeout, Type, Visibility,
 +
          udpPort
 +
 
 +
  [[Myth_Service#TestDBSettings|Myth/TestDBSettings]]                type: POST
 +
 
 +
  Params: DBName, HostName, Password, UserName, dbPort
 +
 
 +
====Video  service====
 +
  [[Video_Service#AddVideo|Video/AddVideo]]                    type: POST
 +
 
 +
  Params: FileName, HostName
 +
 
 +
  [[Video_Service#GetBluray|Video/GetBluray]]                    type: GET
 +
 
 +
  Params: Path
 +
 
 +
  [[Video_Service#GetVideo|Video/GetVideo]]                    type: GET
 +
 
 +
  Params: Id
 +
 
 +
  [[Video_Service#GetVideoByFileName|Video/GetVideoByFileName]]          type: GET
 +
 
 +
  Params: FileName
 +
 
 +
  [[Video_Service#GetVideoList|Video/GetVideoList]]                type: GET
 +
 
 +
  Params: Count, Descending, StartIndex
 +
 
 +
  [[Video_Service#LookupVideo|Video/LookupVideo]]                  type: GET
 +
 
 +
  Params: AllowGeneric, Episode, GrabberType, Inetref, Season, Subtitle,
 +
          Title
 +
 
 +
  [[Video_Service#RemoveVideoFromDB|Video/RemoveVideoFromDB]]            type: POST
 +
 
 +
  Params: Id
 +
 
 +
[[Category:Services_API]]
 +
[[Category:Developer_Documentation]]

Latest revision as of 16:28, 4 December 2015

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 generated automatically from wsdl pages. See API documentation generator.



API routines in 0.27.20141016-1

Capture service

 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 service

 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 service

 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 service

 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 service

 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 service

 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

Myth service

 Myth/AddStorageGroupDir            type: POST
 
 Params: DirName, GroupName, HostName

 Myth/BackupDatabase                type: POST
 
   Params:  (none)

 Myth/ChangePassword                type: POST
 
 Params: NewPassword, OldPassword, UserName

 Myth/CheckDatabase                 type: POST
 
 Params: Repair

 Myth/GetConnectionInfo             type: GET 
 
 Params: Pin

 Myth/GetHostName                   type: GET 
 
   Params:  (none)

 Myth/GetHosts                      type: GET 
 
   Params:  (none)

 Myth/GetKeys                       type: GET 
 
   Params:  (none)

 Myth/GetLogs                       type: GET 
 
 Params: Application, Filename, FromTime, Function, HostName, Level, Line, 
         MsgContains, PID, TID, Thread, ToTime

 Myth/GetSetting                    type: GET 
 
 Params: Default, HostName, Key

 Myth/GetStorageGroupDirs           type: GET 
 
 Params: GroupName, HostName

 Myth/GetTimeZone                   type: GET 
 
   Params:  (none)

 Myth/ProfileDelete                 type: POST
 
   Params:  (none)

 Myth/ProfileSubmit                 type: POST
 
   Params:  (none)

 Myth/ProfileText                   type: GET 
 
   Params:  (none)

 Myth/ProfileURL                    type: GET 
 
   Params:  (none)

 Myth/ProfileUpdated                type: GET 
 
   Params:  (none)

 Myth/PutSetting                    type: POST
 
 Params: HostName, Key, Value

 Myth/RemoveStorageGroupDir         type: POST
 
 Params: DirName, GroupName, HostName

 Myth/SendMessage                   type: GET 
 
 Params: Address, Message, Timeout, udpPort

 Myth/SendNotification              type: GET 
 
 Params: Address, Description, Error, Extra, Fullscreen, Image, Message, 
         Origin, Priority, Progress, ProgressText, Timeout, Type, Visibility, 
         udpPort

 Myth/TestDBSettings                type: POST
 
 Params: DBName, HostName, Password, UserName, dbPort

Video service

 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
Retrieved from "http://www.mythtv.org/wiki?title=API_parameters_0.27&oldid=62754"