Difference between revisions of "API parameters 0.27"

From MythTV Official Wiki
Jump to: navigation, search
(Tidied format; added links to API pages.)
(Added Myth service)
Line 2: Line 2:
  
  
API routines in 0.27.20141016-1
+
 
   [[Capture_Service|Capture]]/AddCaptureCard             type: POST
+
 
 +
==API routines in 0.27.20141016-1==
 +
   [[Capture_Service#AddCaptureCard|Capture/AddCaptureCard]]            type: POST
 
    
 
    
 
   Params: AudioDevice,AudioRateLimit,Brightness,CardType,ChannelTimeout,
 
   Params: AudioDevice,AudioRateLimit,Brightness,CardType,ChannelTimeout,
Line 11: Line 13:
 
           VBIDevice,VideoDevice
 
           VBIDevice,VideoDevice
  
   [[Capture_Service|Capture]]/AddCardInput               type: POST
+
   [[Capture_Service#AddCardInput|Capture/AddCardInput]]              type: POST
 
    
 
    
 
   Params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,ExternalCommand,
 
   Params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,ExternalCommand,
Line 17: Line 19:
 
           SourceId,StartChan,TuneChan
 
           SourceId,StartChan,TuneChan
  
   [[Capture_Service|Capture]]/GetCaptureCard             type: GET
+
   [[Capture_Service#GetCaptureCard|Capture/GetCaptureCard]]            type: GET  
 
    
 
    
 
   Params: CardId
 
   Params: CardId
  
   [[Capture_Service|Capture]]/GetCaptureCardList         type: GET
+
   [[Capture_Service#GetCaptureCardList|Capture/GetCaptureCardList]]        type: GET  
 
    
 
    
 
   Params: CardType,HostName
 
   Params: CardType,HostName
  
   [[Capture_Service|Capture]]/RemoveCaptureCard         type: POST
+
   [[Capture_Service#RemoveCaptureCard|Capture/RemoveCaptureCard]]          type: POST
 
    
 
    
 
   Params: CardId
 
   Params: CardId
  
   [[Capture_Service|Capture]]/RemoveCardInput           type: POST
+
   [[Capture_Service#RemoveCardInput|Capture/RemoveCardInput]]            type: POST
 
    
 
    
 
   Params: CardInputId
 
   Params: CardInputId
  
   [[Capture_Service|Capture]]/UpdateCaptureCard         type: POST
+
   [[Capture_Service#UpdateCaptureCard|Capture/UpdateCaptureCard]]          type: POST
 
    
 
    
 
   Params: CardId,Setting,Value
 
   Params: CardId,Setting,Value
  
   [[Capture_Service|Capture]]/UpdateCardInput           type: POST
+
   [[Capture_Service#UpdateCardInput|Capture/UpdateCardInput]]            type: POST
 
    
 
    
 
   Params: CardInputId,Setting,Value
 
   Params: CardInputId,Setting,Value
  
   [[Channel_Service|Channel]]/AddDBChannel               type: POST
+
   [[Channel_Service#AddDBChannel|Channel/AddDBChannel]]              type: POST
 
    
 
    
 
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
 
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
Line 47: Line 49:
 
           ServiceID,SourceID,UseEIT,XMLTVID,visible
 
           ServiceID,SourceID,UseEIT,XMLTVID,visible
  
   [[Channel_Service|Channel]]/AddVideoSource             type: POST
+
   [[Channel_Service#AddVideoSource|Channel/AddVideoSource]]            type: POST
 
    
 
    
 
   Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceName,
 
   Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceName,
 
           UseEIT,UserId
 
           UseEIT,UserId
  
   [[Channel_Service|Channel]]/FetchChannelsFromSource   type: GET
+
   [[Channel_Service#FetchChannelsFromSource|Channel/FetchChannelsFromSource]]    type: GET  
 
    
 
    
 
   Params: CardId,SourceId,WaitForFinish
 
   Params: CardId,SourceId,WaitForFinish
  
   [[Channel_Service|Channel]]/GetChannelInfo             type: GET
+
   [[Channel_Service#GetChannelInfo|Channel/GetChannelInfo]]            type: GET  
 
    
 
    
 
   Params: ChanID
 
   Params: ChanID
  
   [[Channel_Service|Channel]]/GetChannelInfoList         type: GET
+
   [[Channel_Service#GetChannelInfoList|Channel/GetChannelInfoList]]        type: GET  
 
    
 
    
 
   Params: Count,SourceID,StartIndex
 
   Params: Count,SourceID,StartIndex
  
   [[Channel_Service|Channel]]/GetDDLineupList           type: GET
+
   [[Channel_Service#GetDDLineupList|Channel/GetDDLineupList]]            type: GET  
 
    
 
    
 
   Params: Password,Source,UserId
 
   Params: Password,Source,UserId
  
   [[Channel_Service|Channel]]/GetVideoMultiplex         type: GET
+
   [[Channel_Service#GetVideoMultiplex|Channel/GetVideoMultiplex]]          type: GET  
 
    
 
    
 
   Params: MplexID
 
   Params: MplexID
  
   [[Channel_Service|Channel]]/GetVideoMultiplexList     type: GET
+
   [[Channel_Service#GetVideoMultiplexList|Channel/GetVideoMultiplexList]]      type: GET  
 
    
 
    
 
   Params: Count,SourceID,StartIndex
 
   Params: Count,SourceID,StartIndex
  
   [[Channel_Service|Channel]]/GetVideoSource             type: GET
+
   [[Channel_Service#GetVideoSource|Channel/GetVideoSource]]            type: GET  
 
    
 
    
 
   Params: SourceID
 
   Params: SourceID
  
   [[Channel_Service|Channel]]/GetVideoSourceList         type: GET
+
   [[Channel_Service#GetVideoSourceList|Channel/GetVideoSourceList]]        type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[Channel_Service|Channel]]/GetXMLTVIdList             type: GET
+
   [[Channel_Service#GetXMLTVIdList|Channel/GetXMLTVIdList]]            type: GET  
 
    
 
    
 
   Params: SourceID
 
   Params: SourceID
  
   [[Channel_Service|Channel]]/RemoveDBChannel           type: POST
+
   [[Channel_Service#RemoveDBChannel|Channel/RemoveDBChannel]]            type: POST
 
    
 
    
 
   Params: ChannelID
 
   Params: ChannelID
  
   [[Channel_Service|Channel]]/RemoveVideoSource         type: POST
+
   [[Channel_Service#RemoveVideoSource|Channel/RemoveVideoSource]]          type: POST
 
    
 
    
 
   Params: SourceID
 
   Params: SourceID
  
   [[Channel_Service|Channel]]/UpdateDBChannel           type: POST
+
   [[Channel_Service#UpdateDBChannel|Channel/UpdateDBChannel]]            type: POST
 
    
 
    
 
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
 
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
Line 102: Line 104:
 
           ServiceID,SourceID,UseEIT,XMLTVID,visible
 
           ServiceID,SourceID,UseEIT,XMLTVID,visible
  
   [[Channel_Service|Channel]]/UpdateVideoSource         type: POST
+
   [[Channel_Service#UpdateVideoSource|Channel/UpdateVideoSource]]          type: POST
 
    
 
    
 
   Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceID,
 
   Params: ConfigPath,FreqTable,Grabber,LineupId,NITId,Password,SourceID,
 
           SourceName,UseEIT,UserId
 
           SourceName,UseEIT,UserId
  
   [[Content_Service|Content]]/AddLiveStream             type: GET
+
   [[Content_Service#AddLiveStream|Content/AddLiveStream]]              type: GET  
 
    
 
    
 
   Params: AudioBitrate,Bitrate,FileName,Height,HostName,MaxSegments,SampleRate,
 
   Params: AudioBitrate,Bitrate,FileName,Height,HostName,MaxSegments,SampleRate,
 
           StorageGroup,Width
 
           StorageGroup,Width
  
   [[Content_Service|Content]]/AddRecordingLiveStream     type: GET
+
   [[Content_Service#AddRecordingLiveStream|Content/AddRecordingLiveStream]]    type: GET  
 
    
 
    
 
   Params: AudioBitrate,Bitrate,ChanId,Height,MaxSegments,SampleRate,StartTime,
 
   Params: AudioBitrate,Bitrate,ChanId,Height,MaxSegments,SampleRate,StartTime,
 
           Width
 
           Width
  
   [[Content_Service|Content]]/AddVideoLiveStream         type: GET
+
   [[Content_Service#AddVideoLiveStream|Content/AddVideoLiveStream]]        type: GET  
 
    
 
    
 
   Params: AudioBitrate,Bitrate,Height,Id,MaxSegments,SampleRate,Width
 
   Params: AudioBitrate,Bitrate,Height,Id,MaxSegments,SampleRate,Width
  
   [[Content_Service|Content]]/DownloadFile               type: POST
+
   [[Content_Service#DownloadFile|Content/DownloadFile]]              type: POST
 
    
 
    
 
   Params: StorageGroup,URL
 
   Params: StorageGroup,URL
  
   [[Content_Service|Content]]/GetAlbumArt               type: GET
+
   [[Content_Service#GetAlbumArt|Content/GetAlbumArt]]                type: GET  
 
    
 
    
 
   Params: Height,Id,Width
 
   Params: Height,Id,Width
  
   [[Content_Service|Content]]/GetFile                   type: GET
+
   [[Content_Service#GetFile|Content/GetFile]]                    type: GET  
 
    
 
    
 
   Params: FileName,StorageGroup
 
   Params: FileName,StorageGroup
  
   [[Content_Service|Content]]/GetFileList               type: GET
+
   [[Content_Service#GetFileList|Content/GetFileList]]                type: GET  
 
    
 
    
 
   Params: StorageGroup
 
   Params: StorageGroup
  
   [[Content_Service|Content]]/GetHash                   type: GET
+
   [[Content_Service#GetHash|Content/GetHash]]                    type: GET  
 
    
 
    
 
   Params: FileName,StorageGroup
 
   Params: FileName,StorageGroup
  
   [[Content_Service|Content]]/GetImageFile               type: GET
+
   [[Content_Service#GetImageFile|Content/GetImageFile]]              type: GET  
 
    
 
    
 
   Params: FileName,Height,StorageGroup,Width
 
   Params: FileName,Height,StorageGroup,Width
  
   [[Content_Service|Content]]/GetLiveStream             type: GET
+
   [[Content_Service#GetLiveStream|Content/GetLiveStream]]              type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[Content_Service|Content]]/GetLiveStreamList         type: GET
+
   [[Content_Service#GetLiveStreamList|Content/GetLiveStreamList]]          type: GET  
 
    
 
    
 
   Params: FileName
 
   Params: FileName
  
   [[Content_Service|Content]]/GetMusic                   type: GET
+
   [[Content_Service#GetMusic|Content/GetMusic]]                  type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[Content_Service|Content]]/GetPreviewImage           type: GET
+
   [[Content_Service#GetPreviewImage|Content/GetPreviewImage]]            type: GET  
 
    
 
    
 
   Params: ChanId,Height,SecsIn,StartTime,Width
 
   Params: ChanId,Height,SecsIn,StartTime,Width
  
   [[Content_Service|Content]]/GetProgramArtworkList     type: GET
+
   [[Content_Service#GetProgramArtworkList|Content/GetProgramArtworkList]]      type: GET  
 
    
 
    
 
   Params: Inetref,Season
 
   Params: Inetref,Season
  
   [[Content_Service|Content]]/GetRecording               type: GET
+
   [[Content_Service#GetRecording|Content/GetRecording]]              type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[Content_Service|Content]]/GetRecordingArtwork       type: GET
+
   [[Content_Service#GetRecordingArtwork|Content/GetRecordingArtwork]]        type: GET  
 
    
 
    
 
   Params: Height,Inetref,Season,Type,Width
 
   Params: Height,Inetref,Season,Type,Width
  
   [[Content_Service|Content]]/GetRecordingArtworkList   type: GET
+
   [[Content_Service#GetRecordingArtworkList|Content/GetRecordingArtworkList]]    type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[Content_Service|Content]]/GetVideo                   type: GET
+
   [[Content_Service#GetVideo|Content/GetVideo]]                  type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[Content_Service|Content]]/GetVideoArtwork           type: GET
+
   [[Content_Service#GetVideoArtwork|Content/GetVideoArtwork]]            type: GET  
 
    
 
    
 
   Params: Height,Id,Type,Width
 
   Params: Height,Id,Type,Width
  
   [[Content_Service|Content]]/RemoveLiveStream           type: GET
+
   [[Content_Service#RemoveLiveStream|Content/RemoveLiveStream]]          type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[Content_Service|Content]]/StopLiveStream             type: GET
+
   [[Content_Service#StopLiveStream|Content/StopLiveStream]]            type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[DVR_Service|Dvr]]/AddRecordSchedule             type: POST
+
   [[DVR_Service#AddRecordSchedule|Dvr/AddRecordSchedule]]              type: POST
 
    
 
    
 
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
 
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
Line 203: Line 205:
 
           Type
 
           Type
  
   [[DVR_Service|Dvr]]/DisableRecordSchedule         type: POST
+
   [[DVR_Service#DisableRecordSchedule|Dvr/DisableRecordSchedule]]          type: POST
 
    
 
    
 
   Params: RecordId
 
   Params: RecordId
  
   [[DVR_Service|Dvr]]/EnableRecordSchedule           type: POST
+
   [[DVR_Service#EnableRecordSchedule|Dvr/EnableRecordSchedule]]          type: POST
 
    
 
    
 
   Params: RecordId
 
   Params: RecordId
  
   [[DVR_Service|Dvr]]/GetConflictList               type: GET
+
   [[DVR_Service#GetConflictList|Dvr/GetConflictList]]                type: GET  
 
    
 
    
 
   Params: Count,StartIndex
 
   Params: Count,StartIndex
  
   [[DVR_Service|Dvr]]/GetEncoderList                 type: GET
+
   [[DVR_Service#GetEncoderList|Dvr/GetEncoderList]]                type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[DVR_Service|Dvr]]/GetExpiringList               type: GET
+
   [[DVR_Service#GetExpiringList|Dvr/GetExpiringList]]                type: GET  
 
    
 
    
 
   Params: Count,StartIndex
 
   Params: Count,StartIndex
  
   [[DVR_Service|Dvr]]/GetRecGroupList               type: GET
+
   [[DVR_Service#GetRecGroupList|Dvr/GetRecGroupList]]                type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[DVR_Service|Dvr]]/GetRecordSchedule             type: GET
+
   [[DVR_Service#GetRecordSchedule|Dvr/GetRecordSchedule]]              type: GET  
 
    
 
    
 
   Params: ChanId,MakeOverride,RecordId,StartTime,Template
 
   Params: ChanId,MakeOverride,RecordId,StartTime,Template
  
   [[DVR_Service|Dvr]]/GetRecordScheduleList         type: GET
+
   [[DVR_Service#GetRecordScheduleList|Dvr/GetRecordScheduleList]]          type: GET  
 
    
 
    
 
   Params: Count,StartIndex
 
   Params: Count,StartIndex
  
   [[DVR_Service|Dvr]]/GetRecorded                   type: GET
+
   [[DVR_Service#GetRecorded|Dvr/GetRecorded]]                    type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[DVR_Service|Dvr]]/GetRecordedList               type: GET
+
   [[DVR_Service#GetRecordedList|Dvr/GetRecordedList]]                type: GET  
 
    
 
    
 
   Params: Count,Descending,RecGroup,StartIndex,StorageGroup,TitleRegEx
 
   Params: Count,Descending,RecGroup,StartIndex,StorageGroup,TitleRegEx
  
   [[DVR_Service|Dvr]]/GetTitleInfoList               type: GET
+
   [[DVR_Service#GetTitleInfoList|Dvr/GetTitleInfoList]]              type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[DVR_Service|Dvr]]/GetTitleList                   type: GET
+
   [[DVR_Service#GetTitleList|Dvr/GetTitleList]]                  type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[DVR_Service|Dvr]]/GetUpcomingList               type: GET
+
   [[DVR_Service#GetUpcomingList|Dvr/GetUpcomingList]]                type: GET  
 
    
 
    
 
   Params: Count,ShowAll,StartIndex
 
   Params: Count,ShowAll,StartIndex
  
   [[DVR_Service|Dvr]]/RemoveRecordSchedule           type: POST
+
   [[DVR_Service#RemoveRecordSchedule|Dvr/RemoveRecordSchedule]]          type: POST
 
    
 
    
 
   Params: RecordId
 
   Params: RecordId
  
   [[DVR_Service|Dvr]]/RemoveRecorded                 type: GET
+
   [[DVR_Service#RemoveRecorded|Dvr/RemoveRecorded]]                type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[DVR_Service|Dvr]]/UpdateRecordSchedule           type: POST
+
   [[DVR_Service#UpdateRecordSchedule|Dvr/UpdateRecordSchedule]]          type: POST
 
    
 
    
 
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
 
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
Line 273: Line 275:
 
           Title,Transcoder,Type
 
           Title,Transcoder,Type
  
   [[Frontend_Service|Frontend]]/GetActionList             type: GET
+
   [[Frontend_Service#GetActionList|Frontend/GetActionList]]            type: GET  
 
    
 
    
 
   Params: Context
 
   Params: Context
  
   [[Frontend_Service|Frontend]]/GetContextList           type: GET
+
   [[Frontend_Service#GetContextList|Frontend/GetContextList]]            type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[Frontend_Service|Frontend]]/GetStatus                 type: GET
+
   [[Frontend_Service#GetStatus|Frontend/GetStatus]]                type: GET  
 
    
 
    
 
     Params:  (none)
 
     Params:  (none)
  
   [[Frontend_Service|Frontend]]/PlayRecording             type: GET
+
   [[Frontend_Service#PlayRecording|Frontend/PlayRecording]]            type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[Frontend_Service|Frontend]]/PlayVideo                 type: GET
+
   [[Frontend_Service#PlayVideo|Frontend/PlayVideo]]                type: GET  
 
    
 
    
 
   Params: Id,UseBookmark
 
   Params: Id,UseBookmark
  
   [[Frontend_Service|Frontend]]/SendAction               type: GET
+
   [[Frontend_Service#SendAction|Frontend/SendAction]]                type: GET  
 
    
 
    
 
   Params: Action,Height,Value,Width
 
   Params: Action,Height,Value,Width
  
   [[Frontend_Service|Frontend]]/SendMessage               type: GET
+
   [[Frontend_Service#SendMessage|Frontend/SendMessage]]              type: GET  
 
    
 
    
 
   Params: Message,Timeout
 
   Params: Message,Timeout
  
   [[Frontend_Service|Frontend]]/SendNotification         type: GET
+
   [[Frontend_Service#SendNotification|Frontend/SendNotification]]          type: GET  
 
    
 
    
 
   Params: Description,Error,Extra,Fullscreen,Image,Message,Origin,Priority,
 
   Params: Description,Error,Extra,Fullscreen,Image,Message,Origin,Priority,
 
           Progress,ProgressText,Timeout,Type,Visibility
 
           Progress,ProgressText,Timeout,Type,Visibility
  
   [[Guide_Service|Guide]]/GetChannelIcon               type: GET
+
   [[Guide_Service#GetChannelIcon|Guide/GetChannelIcon]]              type: GET  
 
    
 
    
 
   Params: ChanId,Height,Width
 
   Params: ChanId,Height,Width
  
   [[Guide_Service|Guide]]/GetProgramDetails           type: GET
+
   [[Guide_Service#GetProgramDetails|Guide/GetProgramDetails]]            type: GET  
 
    
 
    
 
   Params: ChanId,StartTime
 
   Params: ChanId,StartTime
  
   [[Guide_Service|Guide]]/GetProgramGuide             type: GET
+
   [[Guide_Service#GetProgramGuide|Guide/GetProgramGuide]]              type: GET  
 
    
 
    
 
   Params: Details,EndTime,NumChannels,StartChanId,StartTime
 
   Params: Details,EndTime,NumChannels,StartChanId,StartTime
  
   [[Video_Service|Video]]/AddVideo                     type: POST
+
  [[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#AddVideo|Video/AddVideo]]                    type: POST
 
    
 
    
 
   Params: FileName,HostName
 
   Params: FileName,HostName
  
   [[Video_Service|Video]]/GetBluray                   type: GET
+
   [[Video_Service#GetBluray|Video/GetBluray]]                    type: GET  
 
    
 
    
 
   Params: Path
 
   Params: Path
  
   [[Video_Service|Video]]/GetVideo                     type: GET
+
   [[Video_Service#GetVideo|Video/GetVideo]]                    type: GET  
 
    
 
    
 
   Params: Id
 
   Params: Id
  
   [[Video_Service|Video]]/GetVideoByFileName           type: GET
+
   [[Video_Service#GetVideoByFileName|Video/GetVideoByFileName]]          type: GET  
 
    
 
    
 
   Params: FileName
 
   Params: FileName
  
   [[Video_Service|Video]]/GetVideoList                 type: GET
+
   [[Video_Service#GetVideoList|Video/GetVideoList]]                type: GET  
 
    
 
    
 
   Params: Count,Descending,StartIndex
 
   Params: Count,Descending,StartIndex
  
   [[Video_Service|Video]]/LookupVideo                 type: GET
+
   [[Video_Service#LookupVideo|Video/LookupVideo]]                  type: GET  
 
    
 
    
 
   Params: AllowGeneric,Episode,GrabberType,Inetref,Season,Subtitle,Title
 
   Params: AllowGeneric,Episode,GrabberType,Inetref,Season,Subtitle,Title
   [[Video_Service|Video]]/RemoveVideoFromDB           type: POST
+
   [[Video_Service#RemoveVideoFromDB|Video/RemoveVideoFromDB]]            type: POST
 
    
 
    
 
   Params: Id
 
   Params: Id

Revision as of 12:42, 6 November 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.



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
 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/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