Function LiveTvApiFp

LiveTvApi - functional programming interface

Export

LiveTvApiFp(configuration?): {
    addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>;
    addTunerHost(tunerHostInfo?: TunerHostInfo, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>)>;
    cancelSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    cancelTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    createTimer(timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteListingProvider(id?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteRecording(recordingId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteTunerHost(id?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    discoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>;
    discvoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>;
    getChannel(channelId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getChannelMappingOptions(providerId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>)>;
    getDefaultListingProvider(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>;
    getDefaultTimer(programId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>;
    getGuideInfo(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>)>;
    getLineups(id?: string, type?: string, location?: string, country?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>;
    getLiveRecordingFile(recordingId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getLiveStreamFile(streamId: string, container: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getLiveTvInfo(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>)>;
    getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getProgram(programId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getPrograms(getProgramsDto?: GetProgramsDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecording(recordingId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getRecordingFolders(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordingGroup(groupId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getRecordingGroups(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSchedulesDirectCountries(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>;
    getSeriesTimers(sortBy?: string, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>)>;
    getTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>)>;
    getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>)>;
    getTunerHostTypes(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>;
    resetTuner(tunerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    setChannelMapping(setChannelMappingDto: SetChannelMappingDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>)>;
    updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}
Parameters
- Optionalconfiguration: Configuration
Returns {
    addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>;
    addTunerHost(tunerHostInfo?: TunerHostInfo, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>)>;
    cancelSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    cancelTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    createTimer(timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteListingProvider(id?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteRecording(recordingId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteTunerHost(id?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    discoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>;
    discvoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>;
    getChannel(channelId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getChannelMappingOptions(providerId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>)>;
    getDefaultListingProvider(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>;
    getDefaultTimer(programId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>;
    getGuideInfo(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>)>;
    getLineups(id?: string, type?: string, location?: string, country?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>;
    getLiveRecordingFile(recordingId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getLiveStreamFile(streamId: string, container: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getLiveTvInfo(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>)>;
    getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getProgram(programId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getPrograms(getProgramsDto?: GetProgramsDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecording(recordingId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getRecordingFolders(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordingGroup(groupId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getRecordingGroups(userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSchedulesDirectCountries(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>;
    getSeriesTimers(sortBy?: string, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>)>;
    getTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>)>;
    getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>)>;
    getTunerHostTypes(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>;
    resetTuner(tunerId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    setChannelMapping(setChannelMappingDto: SetChannelMappingDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>)>;
    updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}
- addListingProvider:function
  - addListingProvider(pw?, validateListings?, validateLogin?, listingsProviderInfo?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>
  - Parameters
    - Optionalpw: string
      Password.
    - OptionalvalidateListings: boolean
      Validate listings.
    - OptionalvalidateLogin: boolean
      Validate login.
    - OptionallistingsProviderInfo: ListingsProviderInfo
      New listings info.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>
    Summary
    Adds a listings provider.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2150
- addTunerHost:function
  - addTunerHost(tunerHostInfo?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>)>
  - Parameters
    - OptionaltunerHostInfo: TunerHostInfo
      New tuner host.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>)>
    Summary
    Adds a tuner host.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2163
- cancelSeriesTimer:function
  - cancelSeriesTimer(timerId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - timerId: string
      Timer id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Cancels a live tv series timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2176
- cancelTimer:function
  - cancelTimer(timerId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - timerId: string
      Timer id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Cancels a live tv timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2189
- createSeriesTimer:function
  - createSeriesTimer(seriesTimerInfoDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - OptionalseriesTimerInfoDto: SeriesTimerInfoDto
      New series timer info.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Creates a live tv series timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2202
- createTimer:function
  - createTimer(timerInfoDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - OptionaltimerInfoDto: TimerInfoDto
      New timer info.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Creates a live tv timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2215
- deleteListingProvider:function
  - deleteListingProvider(id?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - Optionalid: string
      Listing provider id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Delete listing provider.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2228
- deleteRecording:function
  - deleteRecording(recordingId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - recordingId: string
      Recording id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Deletes a live tv recording.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2241
- deleteTunerHost:function
  - deleteTunerHost(id?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - Optionalid: string
      Tuner host id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Deletes a tuner host.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2254
- discoverTuners:function
  - discoverTuners(newDevicesOnly?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>
  - Parameters
    - OptionalnewDevicesOnly: boolean
      Only discover new tuners.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>
    Summary
    Discover tuners.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2267
- discvoverTuners:function
  - discvoverTuners(newDevicesOnly?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>
  - Parameters
    - OptionalnewDevicesOnly: boolean
      Only discover new tuners.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>
    Summary
    Discover tuners.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2280
- getChannel:function
  - getChannel(channelId, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
  - Parameters
    - channelId: string
      Channel id.
    - OptionaluserId: string
      Optional. Attach user data.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
    Summary
    Gets a live tv channel.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2294
- getChannelMappingOptions:function
  - getChannelMappingOptions(providerId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>)>
  - Parameters
    - OptionalproviderId: string
      Provider id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>)>
    Summary
    Get channel mapping options.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2307
- getDefaultListingProvider:function
  - getDefaultListingProvider(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>
    Summary
    Gets default listings provider info.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2319
- getDefaultTimer:function
  - getDefaultTimer(programId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>
  - Parameters
    - OptionalprogramId: string
      Optional. To attach default values based on a program.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>
    Summary
    Gets the default values for a new timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2332
- getGuideInfo:function
  - getGuideInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>)>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>)>
    Summary
    Get guid info.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2344
- getLineups:function
  - getLineups(id?, type?, location?, country?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>
  - Parameters
    - Optionalid: string
      Provider id.
    - Optionaltype: string
      Provider type.
    - Optionallocation: string
      Location.
    - Optionalcountry: string
      Country.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>
    Summary
    Gets available lineups.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2360
- getLiveRecordingFile:function
  - getLiveRecordingFile(recordingId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
  - Parameters
    - recordingId: string
      Recording id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
    Summary
    Gets a live tv recording stream.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2373
- getLiveStreamFile:function
  - getLiveStreamFile(streamId, container, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
  - Parameters
    - streamId: string
      Stream id.
    - container: string
      Container type.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
    Summary
    Gets a live tv channel stream.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2387
- getLiveTvChannels:function
  - getLiveTvChannels(type?, userId?, startIndex?, isMovie?, isSeries?, isNews?, isKids?, isSports?, limit?, isFavorite?, isLiked?, isDisliked?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, sortBy?, sortOrder?, enableFavoriteSorting?, addCurrentProgram?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - Optionaltype: ChannelType
      Optional. Filter by channel type.
    - OptionaluserId: string
      Optional. Filter by user and attach user data.
    - OptionalstartIndex: number
      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    - OptionalisMovie: boolean
      Optional. Filter for movies.
    - OptionalisSeries: boolean
      Optional. Filter for series.
    - OptionalisNews: boolean
      Optional. Filter for news.
    - OptionalisKids: boolean
      Optional. Filter for kids.
    - OptionalisSports: boolean
      Optional. Filter for sports.
    - Optionallimit: number
      Optional. The maximum number of records to return.
    - OptionalisFavorite: boolean
      Optional. Filter by channels that are favorites, or not.
    - OptionalisLiked: boolean
      Optional. Filter by channels that are liked, or not.
    - OptionalisDisliked: boolean
      Optional. Filter by channels that are disliked, or not.
    - OptionalenableImages: boolean
      Optional. Include image information in output.
    - OptionalimageTypeLimit: number
      Optional. The max number of images to return, per image type.
    - OptionalenableImageTypes: ImageType[]
      "Optional. The image types to include in the output.
    - Optionalfields: ItemFields[]
      Optional. Specify additional fields of information to return in the output.
    - OptionalenableUserData: boolean
      Optional. Include user data.
    - OptionalsortBy: ItemSortBy[]
      Optional. Key to sort by.
    - OptionalsortOrder: SortOrder
      Optional. Sort order.
    - OptionalenableFavoriteSorting: boolean
      Optional. Incorporate favorite and like status into channel sorting.
    - OptionaladdCurrentProgram: boolean
      Optional. Adds current program info to each channel.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets available live tv channels.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2420
- getLiveTvInfo:function
  - getLiveTvInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>)>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>)>
    Summary
    Gets available live tv services.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2432
- getLiveTvPrograms:function
  - getLiveTvPrograms(channelIds?, userId?, minStartDate?, hasAired?, isAiring?, maxStartDate?, minEndDate?, maxEndDate?, isMovie?, isSeries?, isNews?, isKids?, isSports?, startIndex?, limit?, sortBy?, sortOrder?, genres?, genreIds?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, seriesTimerId?, librarySeriesId?, fields?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionalchannelIds: string[]
      The channels to return guide information for.
    - OptionaluserId: string
      Optional. Filter by user id.
    - OptionalminStartDate: string
      Optional. The minimum premiere start date.
    - OptionalhasAired: boolean
      Optional. Filter by programs that have completed airing, or not.
    - OptionalisAiring: boolean
      Optional. Filter by programs that are currently airing, or not.
    - OptionalmaxStartDate: string
      Optional. The maximum premiere start date.
    - OptionalminEndDate: string
      Optional. The minimum premiere end date.
    - OptionalmaxEndDate: string
      Optional. The maximum premiere end date.
    - OptionalisMovie: boolean
      Optional. Filter for movies.
    - OptionalisSeries: boolean
      Optional. Filter for series.
    - OptionalisNews: boolean
      Optional. Filter for news.
    - OptionalisKids: boolean
      Optional. Filter for kids.
    - OptionalisSports: boolean
      Optional. Filter for sports.
    - OptionalstartIndex: number
      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    - Optionallimit: number
      Optional. The maximum number of records to return.
    - OptionalsortBy: ItemSortBy[]
      Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
    - OptionalsortOrder: SortOrder[]
      Sort Order - Ascending,Descending.
    - Optionalgenres: string[]
      The genres to return guide information for.
    - OptionalgenreIds: string[]
      The genre ids to return guide information for.
    - OptionalenableImages: boolean
      Optional. Include image information in output.
    - OptionalimageTypeLimit: number
      Optional. The max number of images to return, per image type.
    - OptionalenableImageTypes: ImageType[]
      Optional. The image types to include in the output.
    - OptionalenableUserData: boolean
      Optional. Include user data.
    - OptionalseriesTimerId: string
      Optional. Filter by series timer id.
    - OptionallibrarySeriesId: string
      Optional. Filter by library series id.
    - Optionalfields: ItemFields[]
      Optional. Specify additional fields of information to return in the output.
    - OptionalenableTotalRecordCount: boolean
      Retrieve total record count.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets available live tv epgs.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2471
- getProgram:function
  - getProgram(programId, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
  - Parameters
    - programId: string
      Program id.
    - OptionaluserId: string
      Optional. Attach user data.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
    Summary
    Gets a live tv program.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2485
- getPrograms:function
  - getPrograms(getProgramsDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionalgetProgramsDto: GetProgramsDto
      Request body.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets available live tv epgs.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2498
- getRecommendedPrograms:function
  - getRecommendedPrograms(userId?, limit?, isAiring?, hasAired?, isSeries?, isMovie?, isNews?, isKids?, isSports?, enableImages?, imageTypeLimit?, enableImageTypes?, genreIds?, fields?, enableUserData?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionaluserId: string
      Optional. filter by user id.
    - Optionallimit: number
      Optional. The maximum number of records to return.
    - OptionalisAiring: boolean
      Optional. Filter by programs that are currently airing, or not.
    - OptionalhasAired: boolean
      Optional. Filter by programs that have completed airing, or not.
    - OptionalisSeries: boolean
      Optional. Filter for series.
    - OptionalisMovie: boolean
      Optional. Filter for movies.
    - OptionalisNews: boolean
      Optional. Filter for news.
    - OptionalisKids: boolean
      Optional. Filter for kids.
    - OptionalisSports: boolean
      Optional. Filter for sports.
    - OptionalenableImages: boolean
      Optional. Include image information in output.
    - OptionalimageTypeLimit: number
      Optional. The max number of images to return, per image type.
    - OptionalenableImageTypes: ImageType[]
      Optional. The image types to include in the output.
    - OptionalgenreIds: string[]
      The genres to return guide information for.
    - Optionalfields: ItemFields[]
      Optional. Specify additional fields of information to return in the output.
    - OptionalenableUserData: boolean
      Optional. include user data.
    - OptionalenableTotalRecordCount: boolean
      Retrieve total record count.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets recommended live tv epgs.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2526
- getRecording:function
  - getRecording(recordingId, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
  - Parameters
    - recordingId: string
      Recording id.
    - OptionaluserId: string
      Optional. Attach user data.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>
    Summary
    Gets a live tv recording.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2540
- getRecordingFolders:function
  - getRecordingFolders(userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionaluserId: string
      Optional. Filter by user and attach user data.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets recording folders.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2553
- getRecordingGroup:function
  - getRecordingGroup(groupId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - groupId: string
      Group id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Get recording group.
    
    Deprecated
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2567
- getRecordingGroups:function
  - getRecordingGroups(userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionaluserId: string
      Optional. Filter by user and attach user data.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets live tv recording groups.
    
    Deprecated
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2581
- getRecordings:function
  - getRecordings(channelId?, userId?, startIndex?, limit?, status?, isInProgress?, seriesTimerId?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, isMovie?, isSeries?, isKids?, isSports?, isNews?, isLibraryItem?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionalchannelId: string
      Optional. Filter by channel id.
    - OptionaluserId: string
      Optional. Filter by user and attach user data.
    - OptionalstartIndex: number
      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    - Optionallimit: number
      Optional. The maximum number of records to return.
    - Optionalstatus: RecordingStatus
      Optional. Filter by recording status.
    - OptionalisInProgress: boolean
      Optional. Filter by recordings that are in progress, or not.
    - OptionalseriesTimerId: string
      Optional. Filter by recordings belonging to a series timer.
    - OptionalenableImages: boolean
      Optional. Include image information in output.
    - OptionalimageTypeLimit: number
      Optional. The max number of images to return, per image type.
    - OptionalenableImageTypes: ImageType[]
      Optional. The image types to include in the output.
    - Optionalfields: ItemFields[]
      Optional. Specify additional fields of information to return in the output.
    - OptionalenableUserData: boolean
      Optional. Include user data.
    - OptionalisMovie: boolean
      Optional. Filter for movies.
    - OptionalisSeries: boolean
      Optional. Filter for series.
    - OptionalisKids: boolean
      Optional. Filter for kids.
    - OptionalisSports: boolean
      Optional. Filter for sports.
    - OptionalisNews: boolean
      Optional. Filter for news.
    - OptionalisLibraryItem: boolean
      Optional. Filter for is library item.
    - OptionalenableTotalRecordCount: boolean
      Optional. Return total record count.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets live tv recordings.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2612
- getRecordingsSeries:function
  - getRecordingsSeries(channelId?, userId?, groupId?, startIndex?, limit?, status?, isInProgress?, seriesTimerId?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionalchannelId: string
      Optional. Filter by channel id.
    - OptionaluserId: string
      Optional. Filter by user and attach user data.
    - OptionalgroupId: string
      Optional. Filter by recording group.
    - OptionalstartIndex: number
      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    - Optionallimit: number
      Optional. The maximum number of records to return.
    - Optionalstatus: RecordingStatus
      Optional. Filter by recording status.
    - OptionalisInProgress: boolean
      Optional. Filter by recordings that are in progress, or not.
    - OptionalseriesTimerId: string
      Optional. Filter by recordings belonging to a series timer.
    - OptionalenableImages: boolean
      Optional. Include image information in output.
    - OptionalimageTypeLimit: number
      Optional. The max number of images to return, per image type.
    - OptionalenableImageTypes: ImageType[]
      Optional. The image types to include in the output.
    - Optionalfields: ItemFields[]
      Optional. Specify additional fields of information to return in the output.
    - OptionalenableUserData: boolean
      Optional. Include user data.
    - OptionalenableTotalRecordCount: boolean
      Optional. Return total record count.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets live tv recording series.
    
    Deprecated
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2639
- getSchedulesDirectCountries:function
  - getSchedulesDirectCountries(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>
    Summary
    Gets available countries.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2651
- getSeriesTimer:function
  - getSeriesTimer(timerId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>
  - Parameters
    - timerId: string
      Timer id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>
    Summary
    Gets a live tv series timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2664
- getSeriesTimers:function
  - getSeriesTimers(sortBy?, sortOrder?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>)>
  - Parameters
    - OptionalsortBy: string
      Optional. Sort by SortName or Priority.
    - OptionalsortOrder: SortOrder
      Optional. Sort in Ascending or Descending order.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>)>
    Summary
    Gets live tv series timers.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2678
- getTimer:function
  - getTimer(timerId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>)>
  - Parameters
    - timerId: string
      Timer id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>)>
    Summary
    Gets a timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2691
- getTimers:function
  - getTimers(channelId?, seriesTimerId?, isActive?, isScheduled?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>)>
  - Parameters
    - OptionalchannelId: string
      Optional. Filter by channel id.
    - OptionalseriesTimerId: string
      Optional. Filter by timers belonging to a series timer.
    - OptionalisActive: boolean
      Optional. Filter by timers that are active.
    - OptionalisScheduled: boolean
      Optional. Filter by timers that are scheduled.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>)>
    Summary
    Gets the live tv timers.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2707
- getTunerHostTypes:function
  - getTunerHostTypes(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>)>
    Summary
    Get tuner host types.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2719
- resetTuner:function
  - resetTuner(tunerId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - tunerId: string
      Tuner id.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Resets a tv tuner.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2732
- setChannelMapping:function
  - setChannelMapping(setChannelMappingDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>)>
  - Parameters
    - setChannelMappingDto: SetChannelMappingDto
      The set channel mapping dto.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>)>
    Summary
    Set channel mappings.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2745
- updateSeriesTimer:function
  - updateSeriesTimer(timerId, seriesTimerInfoDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - timerId: string
      Timer id.
    - OptionalseriesTimerInfoDto: SeriesTimerInfoDto
      New series timer info.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Updates a live tv series timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2759
- updateTimer:function
  - updateTimer(timerId, timerInfoDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
  - Parameters
    - timerId: string
      Timer id.
    - OptionaltimerInfoDto: TimerInfoDto
      New timer info.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
    Summary
    Updates a live tv timer.
    
    Throws
    - Defined in generated-client/api/live-tv-api.ts:2773
- Defined in generated-client/api/live-tv-api.ts:2137

Function LiveTvApiFp

Export

Parameters

addListingProvider:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>

Summary

Throws

addTunerHost:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>)>

Summary

Throws

cancelSeriesTimer:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

cancelTimer:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

createSeriesTimer:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

createTimer:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

deleteListingProvider:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

deleteRecording:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

deleteTunerHost:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

Summary

Throws

discoverTuners:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>

Summary

Throws

discvoverTuners:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>)>

Summary

Throws

getChannel:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>

Summary

Throws

getChannelMappingOptions:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>)>

Summary

Throws

getDefaultListingProvider:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>)>

Summary

Throws

getDefaultTimer:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>)>

Summary

Throws

getGuideInfo:function

Parameters