API parameters 30
From MythTV Official Wiki
API parameters 30 This is a full list of API calls, their types (POST or GET), the change status since the initial v29, and the input parameters. This page has been generated automatically by analysing the output of wsdl calls from v29 and v30 systems. See API documentation generator.
Contents
API routines in 0.30.20180101-1
Comparisons are with 0.29.20170212-1
Capture service
Capture/AddCaptureCard type: POST Status: same as 0.29 Params: AudioDevice, AudioRateLimit, Brightness, CardType, ChannelTimeout, Colour, Contrast, DVBDiSEqCType, DVBEITScan, DVBOnDemand, DVBSWFilter, DVBSatType, DVBTuningDelay, DVBWaitForSeqStart, DiSEqCId, FirewireConnection, FirewireModel, FirewireSpeed, HostName, Hue, SignalTimeout, SkipBTAudio, VBIDevice, VideoDevice
Capture/AddCardInput type: POST Status: same as 0.29 Params: CardId, ChangerDevice, ChangerModel, DishnetEIT, DisplayName, ExternalCommand, HostName, InputName, LiveTVOrder, Quicktune, RecPriority, SchedOrder, SourceId, StartChan, TuneChan
Capture/GetCaptureCard type: GET Status: same as 0.29 Params: CardId
Capture/GetCaptureCardList type: GET Status: same as 0.29 Params: CardType, HostName
Capture/RemoveCaptureCard type: POST Status: same as 0.29 Params: CardId
Capture/RemoveCardInput type: POST Status: same as 0.29 Params: CardInputId
Capture/UpdateCaptureCard type: POST Status: same as 0.29 Params: CardId, Setting, Value
Capture/UpdateCardInput type: POST Status: same as 0.29 Params: CardInputId, Setting, Value
Channel service
Channel/AddDBChannel type: POST Status: same as 0.29 Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName, ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID, ServiceID, SourceID, UseEIT, Visible, XMLTVID
Channel/AddVideoSource type: POST Status: same as 0.29 Params: ConfigPath, FreqTable, Grabber, LineupId, NITId, Password, SourceName, UseEIT, UserId
Channel/FetchChannelsFromSource type: GET Status: same as 0.29 Params: CardId, SourceId, WaitForFinish
Channel/GetChannelInfo type: GET Status: same as 0.29 Params: ChanID
Channel/GetChannelInfoList type: GET Status: changed since 0.29 Params: ChannelGroupID, Count, Details, GroupByCallsign, OnlyVisible, OrderByName, SourceID, StartIndex
Channel/GetDDLineupList type: GET Status: same as 0.29 Params: Password, Source, UserId
Channel/GetVideoMultiplex type: GET Status: same as 0.29 Params: MplexID
Channel/GetVideoMultiplexList type: GET Status: same as 0.29 Params: Count, SourceID, StartIndex
Channel/GetVideoSource type: GET Status: same as 0.29 Params: SourceID
Channel/GetVideoSourceList type: GET Status: same as 0.29 Params: (none)
Channel/GetXMLTVIdList type: GET Status: same as 0.29 Params: SourceID
Channel/RemoveDBChannel type: POST Status: same as 0.29 Params: ChannelID
Channel/RemoveVideoSource type: POST Status: same as 0.29 Params: SourceID
Channel/UpdateDBChannel type: POST Status: same as 0.29 Params: ATSCMajorChannel, ATSCMinorChannel, CallSign, ChannelID, ChannelName, ChannelNumber, DefaultAuthority, Format, FrequencyID, Icon, MplexID, ServiceID, SourceID, UseEIT, Visible, XMLTVID
Channel/UpdateVideoSource type: POST Status: same as 0.29 Params: ConfigPath, FreqTable, Grabber, LineupId, NITId, Password, SourceID, SourceName, UseEIT, UserId
Content service
Content/AddLiveStream type: GET Status: same as 0.29 Params: AudioBitrate, Bitrate, FileName, Height, HostName, MaxSegments, SampleRate, StorageGroup, Width
Content/AddRecordingLiveStream type: GET Status: same as 0.29 Params: AudioBitrate, Bitrate, ChanId, Height, MaxSegments, RecordedId, SampleRate, StartTime, Width
Content/AddVideoLiveStream type: GET Status: same as 0.29 Params: AudioBitrate, Bitrate, Height, Id, MaxSegments, SampleRate, Width
Content/DownloadFile type: POST Status: same as 0.29 Params: StorageGroup, URL
Content/GetAlbumArt type: GET Status: same as 0.29 Params: Height, Id, Width
Content/GetDirList type: GET Status: same as 0.29 Params: StorageGroup
Content/GetFile type: GET Status: same as 0.29 Params: FileName, StorageGroup
Content/GetFileList type: GET Status: same as 0.29 Params: StorageGroup
Content/GetHash type: GET Status: same as 0.29 Params: FileName, StorageGroup
Content/GetImageFile type: GET Status: same as 0.29 Params: FileName, Height, StorageGroup, Width
Content/GetLiveStream type: GET Status: same as 0.29 Params: Id
Content/GetLiveStreamList type: GET Status: same as 0.29 Params: FileName
Content/GetMusic type: GET Status: same as 0.29 Params: Id
Content/GetPreviewImage type: GET Status: same as 0.29 Params: ChanId, Format, Height, RecordedId, SecsIn, StartTime, Width
Content/GetProgramArtworkList type: GET Status: same as 0.29 Params: Inetref, Season
Content/GetRecording type: GET Status: same as 0.29 Params: ChanId, RecordedId, StartTime
Content/GetRecordingArtwork type: GET Status: same as 0.29 Params: Height, Inetref, Season, Type, Width
Content/GetRecordingArtworkList type: GET Status: same as 0.29 Params: ChanId, RecordedId, StartTime
Content/GetVideo type: GET Status: same as 0.29 Params: Id
Content/GetVideoArtwork type: GET Status: same as 0.29 Params: Height, Id, Type, Width
Content/RemoveLiveStream type: GET Status: same as 0.29 Params: Id
Content/StopLiveStream type: GET Status: same as 0.29 Params: Id
Dvr service
Dvr/AddDontRecordSchedule type: GET Status: same as 0.29 Params: ChanId, NeverRecord, StartTime
Dvr/AddRecordSchedule type: POST Status: same as 0.29 Params: AutoCommflag, AutoExpire, AutoMetaLookup, AutoTranscode, AutoUserJob1, AutoUserJob2, AutoUserJob3, AutoUserJob4, Category, ChanId, Description, DupIn, DupMethod, EndOffset, EndTime, Episode, Filter, FindDay, FindTime, Inactive, Inetref, MaxEpisodes, MaxNewest, ParentId, PlayGroup, PreferredInput, ProgramId, RecGroup, RecPriority, RecProfile, SearchType, Season, SeriesId, StartOffset, StartTime, Station, StorageGroup, Subtitle, Title, Transcoder, Type
Dvr/DeleteRecording type: POST Status: same as 0.29 Params: AllowRerecord, ChanId, ForceDelete, RecordedId, StartTime
Dvr/DisableRecordSchedule type: POST Status: same as 0.29 Params: RecordId
Dvr/DupInToDescription type: GET Status: same as 0.29 Params: DupIn
Dvr/DupInToString type: GET Status: same as 0.29 Params: DupIn
Dvr/DupMethodToDescription type: GET Status: same as 0.29 Params: DupMethod
Dvr/DupMethodToString type: GET Status: same as 0.29 Params: DupMethod
Dvr/EnableRecordSchedule type: POST Status: same as 0.29 Params: RecordId
Dvr/GetConflictList type: GET Status: same as 0.29 Params: Count, RecordId, StartIndex
Dvr/GetEncoderList type: GET Status: same as 0.29 Params: (none)
Dvr/GetExpiringList type: GET Status: same as 0.29 Params: Count, StartIndex
Dvr/GetInputList type: GET Status: same as 0.29 Params: (none)
Dvr/GetOldRecordedList type: GET Status: same as 0.29 Params: Count, Descending, EndTime, RecordId, SeriesId, Sort, StartIndex, StartTime, Title
Dvr/GetPlayGroupList type: GET Status: same as 0.29 Params: (none)
Dvr/GetProgramCategories type: GET Status: new since 0.29 Params: OnlyRecorded
Dvr/GetRecGroupList type: GET Status: same as 0.29 Params: (none)
Dvr/GetRecRuleFilterList type: GET Status: same as 0.29 Params: (none)
Dvr/GetRecStorageGroupList type: GET Status: same as 0.29 Params: (none)
Dvr/GetRecordSchedule type: GET Status: same as 0.29 Params: ChanId, MakeOverride, RecordId, RecordedId, StartTime, Template
Dvr/GetRecordScheduleList type: GET Status: same as 0.29 Params: Count, Descending, Sort, StartIndex
Dvr/GetRecorded type: GET Status: same as 0.29 Params: ChanId, RecordedId, StartTime
Dvr/GetRecordedCommBreak type: GET Status: same as 0.29 Params: ChanId, OffsetType, RecordedId, StartTime
Dvr/GetRecordedCutList type: GET Status: same as 0.29 Params: ChanId, OffsetType, RecordedId, StartTime
Dvr/GetRecordedList type: GET Status: changed since 0.29 Params: Category, Count, Descending, RecGroup, Sort, StartIndex, StorageGroup, TitleRegEx
Dvr/GetRecordedSeek type: GET Status: same as 0.29 Params: OffsetType, RecordedId
Dvr/GetSavedBookmark type: GET Status: same as 0.29 Params: ChanId, OffsetType, RecordedId, StartTime
Dvr/GetTitleInfoList type: GET Status: same as 0.29 Params: (none)
Dvr/GetTitleList type: GET Status: same as 0.29 Params: RecGroup
Dvr/GetUpcomingList type: GET Status: same as 0.29 Params: Count, RecStatus, RecordId, ShowAll, StartIndex
Dvr/ManageJobQueue type: POST Status: new since 0.29 Params: Action, JobArgs, JobId, JobName, JobStartTime, RecordedId, RemoteHost
Dvr/ReactivateRecording type: GET Status: changed since 0.29 Params: ChanId, RecordedId, StartTime
Dvr/RecStatusToDescription type: GET Status: same as 0.29 Params: RecStatus, RecType, StartTime
Dvr/RecStatusToString type: GET Status: same as 0.29 Params: RecStatus
Dvr/RecTypeToDescription type: GET Status: same as 0.29 Params: RecType
Dvr/RecTypeToString type: GET Status: same as 0.29 Params: RecType
Dvr/RecordedIdForKey type: GET Status: new since 0.29 Params: ChanId, StartTime
Dvr/RecordedIdForPathname type: GET Status: same as 0.29 Params: Pathname
Dvr/RemoveRecordSchedule type: POST Status: same as 0.29 Params: RecordId
Dvr/RemoveRecorded type: POST Status: same as 0.29 Params: AllowRerecord, ChanId, ForceDelete, RecordedId, StartTime
Dvr/RescheduleRecordings type: GET Status: same as 0.29 Params: (none)
Dvr/SetSavedBookmark type: POST Status: same as 0.29 Params: ChanId, Offset, OffsetType, RecordedId, StartTime
Dvr/StopRecording type: GET Status: same as 0.29 Params: RecordedId
Dvr/UnDeleteRecording type: GET Status: same as 0.29 Params: ChanId, RecordedId, StartTime
Dvr/UpdateRecordSchedule type: POST Status: same as 0.29 Params: AutoCommflag, AutoExpire, AutoMetaLookup, AutoTranscode, AutoUserJob1, AutoUserJob2, AutoUserJob3, AutoUserJob4, Category, ChanId, Description, DupIn, DupMethod, EndOffset, EndTime, Episode, Filter, FindDay, FindTime, Inactive, Inetref, MaxEpisodes, MaxNewest, PlayGroup, PreferredInput, ProgramId, RecGroup, RecPriority, RecProfile, RecordId, SearchType, Season, SeriesId, StartOffset, StartTime, Station, StorageGroup, Subtitle, Title, Transcoder, Type
Dvr/UpdateRecordedWatchedStatus type: POST Status: same as 0.29 Params: ChanId, RecordedId, StartTime, Watched
Frontend service
Frontend/GetActionList type: GET Status: same as 0.29 Params: Context
Frontend/GetContextList type: GET Status: same as 0.29 Params: (none)
Frontend/GetStatus type: GET Status: same as 0.29 Params: (none)
Frontend/PlayRecording type: POST Status: same as 0.29 Params: ChanId, RecordedId, StartTime
Frontend/PlayVideo type: POST Status: same as 0.29 Params: Id, UseBookmark
Frontend/SendAction type: POST Status: same as 0.29 Params: Action, Height, Value, Width
Frontend/SendKey type: POST Status: same as 0.29 Params: Key
Frontend/SendMessage type: POST Status: same as 0.29 Params: Message, Timeout
Frontend/SendNotification type: POST Status: same as 0.29 Params: Description, Error, Extra, Fullscreen, Image, Message, Origin, Priority, Progress, ProgressText, Timeout, Type, Visibility
Guide service
Guide/AddToChannelGroup type: POST Status: changed since 0.29 Params: ChanId, ChannelGroupId
Guide/GetCategoryList type: GET Status: same as 0.29 Params: (none)
Guide/GetChannelGroupList type: GET Status: same as 0.29 Params: IncludeEmpty
Guide/GetChannelIcon type: GET Status: same as 0.29 Params: ChanId, Height, Width
Guide/GetProgramDetails type: GET Status: same as 0.29 Params: ChanId, StartTime
Guide/GetProgramGuide type: GET Status: same as 0.29 Params: ChannelGroupId, Count, Details, EndTime, StartIndex, StartTime
Guide/GetProgramList type: GET Status: same as 0.29 Params: CategoryFilter, ChanId, Count, Descending, Details, EndTime, KeywordFilter, OnlyNew, PersonFilter, Sort, StartIndex, StartTime, TitleFilter
Guide/GetStoredSearches type: GET Status: same as 0.29 Params: Type
Guide/RemoveFromChannelGroup type: POST Status: changed since 0.29 Params: ChanId, ChannelGroupId
Myth service
Myth/AddStorageGroupDir type: POST Status: same as 0.29 Params: DirName, GroupName, HostName
Myth/BackupDatabase type: POST Status: same as 0.29 Params: (none)
Myth/ChangePassword type: POST Status: same as 0.29 Params: NewPassword, OldPassword, UserName
Myth/CheckDatabase type: POST Status: same as 0.29 Params: Repair
Myth/GetBackendInfo type: GET Status: same as 0.29 Params: (none)
Myth/GetConnectionInfo type: GET Status: same as 0.29 Params: Pin
Myth/GetFormatDate type: GET Status: same as 0.29 Params: Date, ShortDate
Myth/GetFormatDateTime type: GET Status: same as 0.29 Params: DateTime, ShortDate
Myth/GetFormatTime type: GET Status: same as 0.29 Params: Time
Myth/GetFrontends type: GET Status: same as 0.29 Params: OnLine
Myth/GetHostName type: GET Status: same as 0.29 Params: (none)
Myth/GetHosts type: GET Status: same as 0.29 Params: (none)
Myth/GetKeys type: GET Status: same as 0.29 Params: (none)
Myth/GetLogs type: GET Status: same as 0.29 Params: Application, Filename, FromTime, Function, HostName, Level, Line, MsgContains, PID, TID, Thread, ToTime
Myth/GetSetting type: GET Status: same as 0.29 Params: Default, HostName, Key
Myth/GetSettingList type: GET Status: same as 0.29 Params: HostName
Myth/GetStorageGroupDirs type: GET Status: same as 0.29 Params: GroupName, HostName
Myth/GetTimeZone type: GET Status: same as 0.29 Params: (none)
Myth/ManageDigestUser type: POST Status: new since 0.29 Params: Action, AdminPassword, NewPassword, Password, UserName
Myth/ManageUrlProtection type: POST Status: new since 0.29 Params: AdminPassword, Services
Myth/ParseISODateString type: GET Status: same as 0.29 Params: DateTime
Myth/ProfileDelete type: POST Status: same as 0.29 Params: (none)
Myth/ProfileSubmit type: POST Status: same as 0.29 Params: (none)
Myth/ProfileText type: GET Status: same as 0.29 Params: (none)
Myth/ProfileURL type: GET Status: same as 0.29 Params: (none)
Myth/ProfileUpdated type: GET Status: same as 0.29 Params: (none)
Myth/PutSetting type: POST Status: same as 0.29 Params: HostName, Key, Value
Myth/RemoveStorageGroupDir type: POST Status: same as 0.29 Params: DirName, GroupName, HostName
Myth/SendMessage type: POST Status: same as 0.29 Params: Address, Message, Timeout, udpPort
Myth/SendNotification type: POST Status: same as 0.29 Params: Address, Description, Error, Extra, Fullscreen, Image, Message, Origin, Priority, Progress, ProgressText, Timeout, Type, Visibility, udpPort
Myth/TestDBSettings type: POST Status: same as 0.29 Params: DBName, HostName, Password, UserName, dbPort
Video service
Video/AddVideo type: POST Status: same as 0.29 Params: FileName, HostName
Video/GetBluray type: GET Status: same as 0.29 Params: Path
Video/GetVideo type: GET Status: same as 0.29 Params: Id
Video/GetVideoByFileName type: GET Status: same as 0.29 Params: FileName
Video/GetVideoList type: GET Status: same as 0.29 Params: Count, Descending, Folder, Sort, StartIndex
Video/LookupVideo type: GET Status: same as 0.29 Params: AllowGeneric, Episode, GrabberType, Inetref, Season, Subtitle, Title
Video/RemoveVideoFromDB type: POST Status: same as 0.29 Params: Id
Video/UpdateVideoMetadata type: POST Status: same as 0.29 Params: Banner, Browse, Cast, Category, ChildID, CollectionRef, ContentType, Countries, CoverFile, Director, Episode, Fanart, FileName, Genres, Hash, HomePage, Host, Id, Inetref, InsertDate, Length, PlayCommand, PlayCount, Plot, Processed, Rating, ReleaseDate, Screenshot, Season, ShowLevel, Studio, SubTitle, TagLine, Title, Trailer, UserRating, Watched, Year
Video/UpdateVideoWatchedStatus type: POST Status: same as 0.29 Params: Id, Watched