Difference between revisions of "API parameters 0.27"

From MythTV Official Wiki
Jump to: navigation, search
(Added Myth service)
(Bug fixes, added Myth, added headings & categories)
Line 5: Line 5:
  
 
==API routines in 0.27.20141016-1==
 
==API routines in 0.27.20141016-1==
 +
====Capture  service====
 
   [[Capture_Service#AddCaptureCard|Capture/AddCaptureCard]]            type: POST
 
   [[Capture_Service#AddCaptureCard|Capture/AddCaptureCard]]            type: POST
 
    
 
    
−
   Params: AudioDevice,AudioRateLimit,Brightness,CardType,ChannelTimeout,
+
   Params: AudioDevice, AudioRateLimit, Brightness, CardType, ChannelTimeout,  
−
           Colour,Contrast,DVBDiSEqCType,DVBEITScan,DVBOnDemand,DVBSWFilter,
+
           Colour, Contrast, DVBDiSEqCType, DVBEITScan, DVBOnDemand, DVBSWFilter,  
−
           DVBSatType,DVBTuningDelay,DVBWaitForSeqStart,DiSEqCId,FirewireConnection,
+
           DVBSatType, DVBTuningDelay, DVBWaitForSeqStart, DiSEqCId, FirewireConnection,  
−
           FirewireModel,FirewireSpeed,HostName,Hue,SignalTimeout,SkipBTAudio,
+
           FirewireModel, FirewireSpeed, HostName, Hue, SignalTimeout, SkipBTAudio,  
−
           VBIDevice,VideoDevice
+
           VBIDevice, VideoDevice
  
 
   [[Capture_Service#AddCardInput|Capture/AddCardInput]]              type: POST
 
   [[Capture_Service#AddCardInput|Capture/AddCardInput]]              type: POST
 
    
 
    
−
   Params: CardId,ChangerDevice,ChangerModel,DishnetEIT,DisplayName,ExternalCommand,
+
   Params: CardId, ChangerDevice, ChangerModel, DishnetEIT, DisplayName,  
−
          HostName,InputName,LiveTVOrder,Quicktune,RecPriority,SchedOrder,
+
          ExternalCommand, HostName, InputName, LiveTVOrder, Quicktune,  
−
          SourceId,StartChan,TuneChan
+
          RecPriority, SchedOrder, SourceId, StartChan, TuneChan
  
 
   [[Capture_Service#GetCaptureCard|Capture/GetCaptureCard]]            type: GET  
 
   [[Capture_Service#GetCaptureCard|Capture/GetCaptureCard]]            type: GET  
Line 25: Line 26:
 
   [[Capture_Service#GetCaptureCardList|Capture/GetCaptureCardList]]        type: GET  
 
   [[Capture_Service#GetCaptureCardList|Capture/GetCaptureCardList]]        type: GET  
 
    
 
    
−
   Params: CardType,HostName
+
   Params: CardType, HostName
  
 
   [[Capture_Service#RemoveCaptureCard|Capture/RemoveCaptureCard]]          type: POST
 
   [[Capture_Service#RemoveCaptureCard|Capture/RemoveCaptureCard]]          type: POST
Line 37: Line 38:
 
   [[Capture_Service#UpdateCaptureCard|Capture/UpdateCaptureCard]]          type: POST
 
   [[Capture_Service#UpdateCaptureCard|Capture/UpdateCaptureCard]]          type: POST
 
    
 
    
−
   Params: CardId,Setting,Value
+
   Params: CardId, Setting, Value
  
 
   [[Capture_Service#UpdateCardInput|Capture/UpdateCardInput]]            type: POST
 
   [[Capture_Service#UpdateCardInput|Capture/UpdateCardInput]]            type: POST
 
    
 
    
−
   Params: CardInputId,Setting,Value
+
   Params: CardInputId, Setting, Value
  
 +
====Channel  service====
 
   [[Channel_Service#AddDBChannel|Channel/AddDBChannel]]              type: POST
 
   [[Channel_Service#AddDBChannel|Channel/AddDBChannel]]              type: POST
 
    
 
    
−
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
+
   Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName,  
−
           ChannelNumber,DefaultAuthority,Format,FrequencyID,Icon,MplexID,
+
           ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID,  
−
           ServiceID,SourceID,UseEIT,XMLTVID,visible
+
           ServiceID, SourceID, UseEIT, XMLTVID, visible
  
 
   [[Channel_Service#AddVideoSource|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#FetchChannelsFromSource|Channel/FetchChannelsFromSource]]    type: GET  
 
   [[Channel_Service#FetchChannelsFromSource|Channel/FetchChannelsFromSource]]    type: GET  
 
    
 
    
−
   Params: CardId,SourceId,WaitForFinish
+
   Params: CardId, SourceId, WaitForFinish
  
 
   [[Channel_Service#GetChannelInfo|Channel/GetChannelInfo]]            type: GET  
 
   [[Channel_Service#GetChannelInfo|Channel/GetChannelInfo]]            type: GET  
Line 64: Line 66:
 
   [[Channel_Service#GetChannelInfoList|Channel/GetChannelInfoList]]        type: GET  
 
   [[Channel_Service#GetChannelInfoList|Channel/GetChannelInfoList]]        type: GET  
 
    
 
    
−
   Params: Count,SourceID,StartIndex
+
   Params: Count, SourceID, StartIndex
  
 
   [[Channel_Service#GetDDLineupList|Channel/GetDDLineupList]]            type: GET  
 
   [[Channel_Service#GetDDLineupList|Channel/GetDDLineupList]]            type: GET  
 
    
 
    
−
   Params: Password,Source,UserId
+
   Params: Password, Source, UserId
  
 
   [[Channel_Service#GetVideoMultiplex|Channel/GetVideoMultiplex]]          type: GET  
 
   [[Channel_Service#GetVideoMultiplex|Channel/GetVideoMultiplex]]          type: GET  
Line 76: Line 78:
 
   [[Channel_Service#GetVideoMultiplexList|Channel/GetVideoMultiplexList]]      type: GET  
 
   [[Channel_Service#GetVideoMultiplexList|Channel/GetVideoMultiplexList]]      type: GET  
 
    
 
    
−
   Params: Count,SourceID,StartIndex
+
   Params: Count, SourceID, StartIndex
  
 
   [[Channel_Service#GetVideoSource|Channel/GetVideoSource]]            type: GET  
 
   [[Channel_Service#GetVideoSource|Channel/GetVideoSource]]            type: GET  
Line 100: Line 102:
 
   [[Channel_Service#UpdateDBChannel|Channel/UpdateDBChannel]]            type: POST
 
   [[Channel_Service#UpdateDBChannel|Channel/UpdateDBChannel]]            type: POST
 
    
 
    
−
   Params: ATSCMajorChannel,ATSCMinorChannel,CallSign,ChannelID,ChannelName,
+
   Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName,  
−
           ChannelNumber,DefaultAuthority,Format,FrequencyID,Icon,MplexID,
+
           ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID,  
−
           ServiceID,SourceID,UseEIT,XMLTVID,visible
+
           ServiceID, SourceID, UseEIT, XMLTVID, visible
  
 
   [[Channel_Service#UpdateVideoSource|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_Service#AddLiveStream|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,  
−
          StorageGroup,Width
+
          SampleRate, StorageGroup, Width
  
 
   [[Content_Service#AddRecordingLiveStream|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,  
−
          Width
+
          StartTime, Width
  
 
   [[Content_Service#AddVideoLiveStream|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#DownloadFile|Content/DownloadFile]]              type: POST
 
   [[Content_Service#DownloadFile|Content/DownloadFile]]              type: POST
 
    
 
    
−
   Params: StorageGroup,URL
+
   Params: StorageGroup, URL
  
 
   [[Content_Service#GetAlbumArt|Content/GetAlbumArt]]                type: GET  
 
   [[Content_Service#GetAlbumArt|Content/GetAlbumArt]]                type: GET  
 
    
 
    
−
   Params: Height,Id,Width
+
   Params: Height, Id, Width
  
 
   [[Content_Service#GetFile|Content/GetFile]]                    type: GET  
 
   [[Content_Service#GetFile|Content/GetFile]]                    type: GET  
 
    
 
    
−
   Params: FileName,StorageGroup
+
   Params: FileName, StorageGroup
  
 
   [[Content_Service#GetFileList|Content/GetFileList]]                type: GET  
 
   [[Content_Service#GetFileList|Content/GetFileList]]                type: GET  
Line 141: Line 144:
 
   [[Content_Service#GetHash|Content/GetHash]]                    type: GET  
 
   [[Content_Service#GetHash|Content/GetHash]]                    type: GET  
 
    
 
    
−
   Params: FileName,StorageGroup
+
   Params: FileName, StorageGroup
  
 
   [[Content_Service#GetImageFile|Content/GetImageFile]]              type: GET  
 
   [[Content_Service#GetImageFile|Content/GetImageFile]]              type: GET  
 
    
 
    
−
   Params: FileName,Height,StorageGroup,Width
+
   Params: FileName, Height, StorageGroup, Width
  
 
   [[Content_Service#GetLiveStream|Content/GetLiveStream]]              type: GET  
 
   [[Content_Service#GetLiveStream|Content/GetLiveStream]]              type: GET  
Line 161: Line 164:
 
   [[Content_Service#GetPreviewImage|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#GetProgramArtworkList|Content/GetProgramArtworkList]]      type: GET  
 
   [[Content_Service#GetProgramArtworkList|Content/GetProgramArtworkList]]      type: GET  
 
    
 
    
−
   Params: Inetref,Season
+
   Params: Inetref, Season
  
 
   [[Content_Service#GetRecording|Content/GetRecording]]              type: GET  
 
   [[Content_Service#GetRecording|Content/GetRecording]]              type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[Content_Service#GetRecordingArtwork|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#GetRecordingArtworkList|Content/GetRecordingArtworkList]]    type: GET  
 
   [[Content_Service#GetRecordingArtworkList|Content/GetRecordingArtworkList]]    type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[Content_Service#GetVideo|Content/GetVideo]]                  type: GET  
 
   [[Content_Service#GetVideo|Content/GetVideo]]                  type: GET  
Line 185: Line 188:
 
   [[Content_Service#GetVideoArtwork|Content/GetVideoArtwork]]            type: GET  
 
   [[Content_Service#GetVideoArtwork|Content/GetVideoArtwork]]            type: GET  
 
    
 
    
−
   Params: Height,Id,Type,Width
+
   Params: Height, Id, Type, Width
  
 
   [[Content_Service#RemoveLiveStream|Content/RemoveLiveStream]]          type: GET  
 
   [[Content_Service#RemoveLiveStream|Content/RemoveLiveStream]]          type: GET  
Line 195: Line 198:
 
   Params: Id
 
   Params: Id
  
 +
====Dvr  service====
 
   [[DVR_Service#AddRecordSchedule|Dvr/AddRecordSchedule]]              type: POST
 
   [[DVR_Service#AddRecordSchedule|Dvr/AddRecordSchedule]]              type: POST
 
    
 
    
−
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
+
   Params: AutoCommflag, AutoExpire, AutoMetaLookup, AutoTranscode, AutoUserJob1,  
−
           AutoUserJob2,AutoUserJob3,AutoUserJob4,Category,ChanId,Description,
+
           AutoUserJob2, AutoUserJob3, AutoUserJob4, Category, ChanId, Description,  
−
           DupIn,DupMethod,EndOffset,EndTime,Episode,Filter,FindDay,FindTime,
+
           DupIn, DupMethod, EndOffset, EndTime, Episode, Filter, FindDay,  
−
          Inactive,Inetref,MaxEpisodes,MaxNewest,ParentId,PlayGroup,PreferredInput,
+
          FindTime, Inactive, Inetref, MaxEpisodes, MaxNewest, ParentId,  
−
          ProgramId,RecGroup,RecPriority,RecProfile,SearchType,Season,SeriesId,
+
          PlayGroup, PreferredInput, ProgramId, RecGroup, RecPriority,  
−
          StartOffset,StartTime,Station,StorageGroup,Subtitle,Title,Transcoder,
+
          RecProfile, SearchType, Season, SeriesId, StartOffset, StartTime,  
−
          Type
+
          Station, StorageGroup, Subtitle, Title, Transcoder, Type
  
 
   [[DVR_Service#DisableRecordSchedule|Dvr/DisableRecordSchedule]]          type: POST
 
   [[DVR_Service#DisableRecordSchedule|Dvr/DisableRecordSchedule]]          type: POST
Line 215: Line 219:
 
   [[DVR_Service#GetConflictList|Dvr/GetConflictList]]                type: GET  
 
   [[DVR_Service#GetConflictList|Dvr/GetConflictList]]                type: GET  
 
    
 
    
−
   Params: Count,StartIndex
+
   Params: Count, StartIndex
  
 
   [[DVR_Service#GetEncoderList|Dvr/GetEncoderList]]                type: GET  
 
   [[DVR_Service#GetEncoderList|Dvr/GetEncoderList]]                type: GET  
Line 223: Line 227:
 
   [[DVR_Service#GetExpiringList|Dvr/GetExpiringList]]                type: GET  
 
   [[DVR_Service#GetExpiringList|Dvr/GetExpiringList]]                type: GET  
 
    
 
    
−
   Params: Count,StartIndex
+
   Params: Count, StartIndex
  
 
   [[DVR_Service#GetRecGroupList|Dvr/GetRecGroupList]]                type: GET  
 
   [[DVR_Service#GetRecGroupList|Dvr/GetRecGroupList]]                type: GET  
Line 231: Line 235:
 
   [[DVR_Service#GetRecordSchedule|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#GetRecordScheduleList|Dvr/GetRecordScheduleList]]          type: GET  
 
   [[DVR_Service#GetRecordScheduleList|Dvr/GetRecordScheduleList]]          type: GET  
 
    
 
    
−
   Params: Count,StartIndex
+
   Params: Count, StartIndex
  
 
   [[DVR_Service#GetRecorded|Dvr/GetRecorded]]                    type: GET  
 
   [[DVR_Service#GetRecorded|Dvr/GetRecorded]]                    type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[DVR_Service#GetRecordedList|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#GetTitleInfoList|Dvr/GetTitleInfoList]]              type: GET  
 
   [[DVR_Service#GetTitleInfoList|Dvr/GetTitleInfoList]]              type: GET  
Line 255: Line 259:
 
   [[DVR_Service#GetUpcomingList|Dvr/GetUpcomingList]]                type: GET  
 
   [[DVR_Service#GetUpcomingList|Dvr/GetUpcomingList]]                type: GET  
 
    
 
    
−
   Params: Count,ShowAll,StartIndex
+
   Params: Count, ShowAll, StartIndex
  
 
   [[DVR_Service#RemoveRecordSchedule|Dvr/RemoveRecordSchedule]]          type: POST
 
   [[DVR_Service#RemoveRecordSchedule|Dvr/RemoveRecordSchedule]]          type: POST
Line 263: Line 267:
 
   [[DVR_Service#RemoveRecorded|Dvr/RemoveRecorded]]                type: GET  
 
   [[DVR_Service#RemoveRecorded|Dvr/RemoveRecorded]]                type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[DVR_Service#UpdateRecordSchedule|Dvr/UpdateRecordSchedule]]          type: POST
 
   [[DVR_Service#UpdateRecordSchedule|Dvr/UpdateRecordSchedule]]          type: POST
 
    
 
    
−
   Params: AutoCommflag,AutoExpire,AutoMetaLookup,AutoTranscode,AutoUserJob1,
+
   Params: AutoCommflag, AutoExpire, AutoMetaLookup, AutoTranscode, AutoUserJob1,  
−
           AutoUserJob2,AutoUserJob3,AutoUserJob4,Category,ChanId,Description,
+
           AutoUserJob2, AutoUserJob3, AutoUserJob4, Category, ChanId, Description,  
−
           DupIn,DupMethod,EndOffset,EndTime,Episode,Filter,FindDay,FindTime,
+
           DupIn, DupMethod, EndOffset, EndTime, Episode, Filter, FindDay,  
−
          Inactive,Inetref,MaxEpisodes,MaxNewest,PlayGroup,PreferredInput,
+
          FindTime, Inactive, Inetref, MaxEpisodes, MaxNewest, PlayGroup,  
−
          ProgramId,RecGroup,RecPriority,RecProfile,RecordId,SearchType,
+
          PreferredInput, ProgramId, RecGroup, RecPriority, RecProfile,  
−
          Season,SeriesId,StartOffset,StartTime,Station,StorageGroup,Subtitle,
+
          RecordId, SearchType, Season, SeriesId, StartOffset, StartTime,  
−
          Title,Transcoder,Type
+
          Station, StorageGroup, Subtitle, Title, Transcoder, Type
  
 +
====Frontend  service====
 
   [[Frontend_Service#GetActionList|Frontend/GetActionList]]            type: GET  
 
   [[Frontend_Service#GetActionList|Frontend/GetActionList]]            type: GET  
 
    
 
    
Line 289: Line 294:
 
   [[Frontend_Service#PlayRecording|Frontend/PlayRecording]]            type: GET  
 
   [[Frontend_Service#PlayRecording|Frontend/PlayRecording]]            type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[Frontend_Service#PlayVideo|Frontend/PlayVideo]]                type: GET  
 
   [[Frontend_Service#PlayVideo|Frontend/PlayVideo]]                type: GET  
 
    
 
    
−
   Params: Id,UseBookmark
+
   Params: Id, UseBookmark
  
 
   [[Frontend_Service#SendAction|Frontend/SendAction]]                type: GET  
 
   [[Frontend_Service#SendAction|Frontend/SendAction]]                type: GET  
 
    
 
    
−
   Params: Action,Height,Value,Width
+
   Params: Action, Height, Value, Width
  
 
   [[Frontend_Service#SendMessage|Frontend/SendMessage]]              type: GET  
 
   [[Frontend_Service#SendMessage|Frontend/SendMessage]]              type: GET  
 
    
 
    
−
   Params: Message,Timeout
+
   Params: Message, Timeout
  
 
   [[Frontend_Service#SendNotification|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,  
−
          Progress,ProgressText,Timeout,Type,Visibility
+
          Priority, Progress, ProgressText, Timeout, Type, Visibility
  
 +
====Guide  service====
 
   [[Guide_Service#GetChannelIcon|Guide/GetChannelIcon]]              type: GET  
 
   [[Guide_Service#GetChannelIcon|Guide/GetChannelIcon]]              type: GET  
 
    
 
    
−
   Params: ChanId,Height,Width
+
   Params: ChanId, Height, Width
  
 
   [[Guide_Service#GetProgramDetails|Guide/GetProgramDetails]]            type: GET  
 
   [[Guide_Service#GetProgramDetails|Guide/GetProgramDetails]]            type: GET  
 
    
 
    
−
   Params: ChanId,StartTime
+
   Params: ChanId, StartTime
  
 
   [[Guide_Service#GetProgramGuide|Guide/GetProgramGuide]]              type: GET  
 
   [[Guide_Service#GetProgramGuide|Guide/GetProgramGuide]]              type: GET  
 
    
 
    
−
   Params: Details,EndTime,NumChannels,StartChanId,StartTime
+
   Params: Details, EndTime, NumChannels, StartChanId, StartTime
  
 +
====Myth  service====
 
   [[Myth_Service#AddStorageGroupDir|Myth/AddStorageGroupDir]]            type: POST
 
   [[Myth_Service#AddStorageGroupDir|Myth/AddStorageGroupDir]]            type: POST
 
    
 
    
−
   Params: DirName,GroupName,HostName
+
   Params: DirName, GroupName, HostName
  
 
   [[Myth_Service#BackupDatabase|Myth/BackupDatabase]]                type: POST
 
   [[Myth_Service#BackupDatabase|Myth/BackupDatabase]]                type: POST
Line 330: Line 337:
 
   [[Myth_Service#ChangePassword|Myth/ChangePassword]]                type: POST
 
   [[Myth_Service#ChangePassword|Myth/ChangePassword]]                type: POST
 
    
 
    
−
   Params: NewPassword,OldPassword,UserName
+
   Params: NewPassword, OldPassword, UserName
  
 
   [[Myth_Service#CheckDatabase|Myth/CheckDatabase]]                type: POST
 
   [[Myth_Service#CheckDatabase|Myth/CheckDatabase]]                type: POST
Line 354: Line 361:
 
   [[Myth_Service#GetLogs|Myth/GetLogs]]                      type: GET  
 
   [[Myth_Service#GetLogs|Myth/GetLogs]]                      type: GET  
 
    
 
    
−
   Params: Application,Filename,FromTime,Function,HostName,Level,Line,MsgContains,
+
   Params: Application, Filename, FromTime, Function, HostName, Level, Line,  
−
          PID,TID,Thread,ToTime
+
          MsgContains, PID, TID, Thread, ToTime
  
 
   [[Myth_Service#GetSetting|Myth/GetSetting]]                    type: GET  
 
   [[Myth_Service#GetSetting|Myth/GetSetting]]                    type: GET  
 
    
 
    
−
   Params: Default,HostName,Key
+
   Params: Default, HostName, Key
  
 
   [[Myth_Service#GetStorageGroupDirs|Myth/GetStorageGroupDirs]]          type: GET  
 
   [[Myth_Service#GetStorageGroupDirs|Myth/GetStorageGroupDirs]]          type: GET  
 
    
 
    
−
   Params: GroupName,HostName
+
   Params: GroupName, HostName
  
 
   [[Myth_Service#GetTimeZone|Myth/GetTimeZone]]                  type: GET  
 
   [[Myth_Service#GetTimeZone|Myth/GetTimeZone]]                  type: GET  
Line 391: Line 398:
 
   [[Myth_Service#PutSetting|Myth/PutSetting]]                    type: POST
 
   [[Myth_Service#PutSetting|Myth/PutSetting]]                    type: POST
 
    
 
    
−
   Params: HostName,Key,Value
+
   Params: HostName, Key, Value
  
 
   [[Myth_Service#RemoveStorageGroupDir|Myth/RemoveStorageGroupDir]]        type: POST
 
   [[Myth_Service#RemoveStorageGroupDir|Myth/RemoveStorageGroupDir]]        type: POST
 
    
 
    
−
   Params: DirName,GroupName,HostName
+
   Params: DirName, GroupName, HostName
  
 
   [[Myth_Service#SendMessage|Myth/SendMessage]]                  type: GET  
 
   [[Myth_Service#SendMessage|Myth/SendMessage]]                  type: GET  
 
    
 
    
−
   Params: Address,Message,Timeout,udpPort
+
   Params: Address, Message, Timeout, udpPort
  
 
   [[Myth_Service#SendNotification|Myth/SendNotification]]              type: GET  
 
   [[Myth_Service#SendNotification|Myth/SendNotification]]              type: GET  
 
    
 
    
−
   Params: Address,Description,Error,Extra,Fullscreen,Image,Message,Origin,
+
   Params: Address, Description, Error, Extra, Fullscreen, Image, Message,  
−
          Priority,Progress,ProgressText,Timeout,Type,Visibility,udpPort
+
          Origin, Priority, Progress, ProgressText, Timeout, Type, Visibility,  
 +
          udpPort
 +
 
 
   [[Myth_Service#TestDBSettings|Myth/TestDBSettings]]                type: POST
 
   [[Myth_Service#TestDBSettings|Myth/TestDBSettings]]                type: POST
 
    
 
    
−
   Params: DBName,HostName,Password,UserName,dbPort
+
   Params: DBName, HostName, Password, UserName, dbPort
  
 +
====Video  service====
 
   [[Video_Service#AddVideo|Video/AddVideo]]                    type: POST
 
   [[Video_Service#AddVideo|Video/AddVideo]]                    type: POST
 
    
 
    
−
   Params: FileName,HostName
+
   Params: FileName, HostName
  
 
   [[Video_Service#GetBluray|Video/GetBluray]]                    type: GET  
 
   [[Video_Service#GetBluray|Video/GetBluray]]                    type: GET  
Line 427: Line 437:
 
   [[Video_Service#GetVideoList|Video/GetVideoList]]                type: GET  
 
   [[Video_Service#GetVideoList|Video/GetVideoList]]                type: GET  
 
    
 
    
−
   Params: Count,Descending,StartIndex
+
   Params: Count, Descending, StartIndex
  
 
   [[Video_Service#LookupVideo|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#RemoveVideoFromDB|Video/RemoveVideoFromDB]]            type: POST
 
   [[Video_Service#RemoveVideoFromDB|Video/RemoveVideoFromDB]]            type: POST
 
    
 
    
 
   Params: Id
 
   Params: Id
 +
 +
[[Category:Services_API]]
 +
[[Category:Developer_Documentation]]

Revision as of 19:21, 9 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 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=62695"