Class LiveTvApi

LiveTvApi - object-oriented interface

Export

LiveTvApi

Hierarchy

BaseAPI
- LiveTvApi

Constructors

constructor

new LiveTvApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): LiveTvApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LiveTvApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

addListingProvider

addListingProvider(
requestParameters?: LiveTvApiAddListingProviderRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListingsProviderInfo, any>>
Parameters
- requestParameters: LiveTvApiAddListingProviderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListingsProviderInfo, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4475

addTunerHost

addTunerHost(
requestParameters?: LiveTvApiAddTunerHostRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TunerHostInfo, any>>
Parameters
- requestParameters: LiveTvApiAddTunerHostRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4487

cancelSeriesTimer

cancelSeriesTimer(
requestParameters: LiveTvApiCancelSeriesTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCancelSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4499

cancelTimer

cancelTimer(
requestParameters: LiveTvApiCancelTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCancelTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4511

createSeriesTimer

createSeriesTimer(
requestParameters?: LiveTvApiCreateSeriesTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCreateSeriesTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4523

createTimer

createTimer(
requestParameters?: LiveTvApiCreateTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCreateTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4535

deleteListingProvider

deleteListingProvider(
requestParameters?: LiveTvApiDeleteListingProviderRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteListingProviderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4547

deleteRecording

deleteRecording(
requestParameters: LiveTvApiDeleteRecordingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteRecordingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4559

deleteTunerHost

deleteTunerHost(
requestParameters?: LiveTvApiDeleteTunerHostRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteTunerHostRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4571

discoverTuners

discoverTuners(
requestParameters?: LiveTvApiDiscoverTunersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TunerHostInfo[], any>>
Parameters
- requestParameters: LiveTvApiDiscoverTunersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo[], any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4583

discvoverTuners

discvoverTuners(
requestParameters?: LiveTvApiDiscvoverTunersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TunerHostInfo[], any>>
Parameters
- requestParameters: LiveTvApiDiscvoverTunersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo[], any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4595

getChannel

getChannel(
requestParameters: LiveTvApiGetChannelRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetChannelRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4607

getChannelMappingOptions

getChannelMappingOptions(
requestParameters?: LiveTvApiGetChannelMappingOptionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelMappingOptionsDto, any>>
Parameters
- requestParameters: LiveTvApiGetChannelMappingOptionsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelMappingOptionsDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4619

getDefaultListingProvider

getDefaultListingProvider(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListingsProviderInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListingsProviderInfo, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4630

getDefaultTimer

getDefaultTimer(
requestParameters?: LiveTvApiGetDefaultTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetDefaultTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4642

getGuideInfo

getGuideInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GuideInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuideInfo, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4653

getLineups

getLineups(
requestParameters?: LiveTvApiGetLineupsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- requestParameters: LiveTvApiGetLineupsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4665

getLiveRecordingFile

getLiveRecordingFile(
requestParameters: LiveTvApiGetLiveRecordingFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LiveTvApiGetLiveRecordingFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4677

getLiveStreamFile

getLiveStreamFile(
requestParameters: LiveTvApiGetLiveStreamFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LiveTvApiGetLiveStreamFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4689

getLiveTvChannels

getLiveTvChannels(
requestParameters?: LiveTvApiGetLiveTvChannelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetLiveTvChannelsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4701

getLiveTvInfo

getLiveTvInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LiveTvInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LiveTvInfo, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4712

getLiveTvPrograms

getLiveTvPrograms(
requestParameters?: LiveTvApiGetLiveTvProgramsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetLiveTvProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4724

getProgram

getProgram(
requestParameters: LiveTvApiGetProgramRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetProgramRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4736

getPrograms

getPrograms(
requestParameters?: LiveTvApiGetProgramsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4748

getRecommendedPrograms

getRecommendedPrograms(
requestParameters?: LiveTvApiGetRecommendedProgramsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecommendedProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4760

getRecording

getRecording(
requestParameters: LiveTvApiGetRecordingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4772

getRecordingFolders

getRecordingFolders(
requestParameters?: LiveTvApiGetRecordingFoldersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingFoldersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4784

getRecordingGroup

getRecordingGroup(
requestParameters: LiveTvApiGetRecordingGroupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4797

getRecordingGroups

getRecordingGroups(
requestParameters?: LiveTvApiGetRecordingGroupsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingGroupsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4810

getRecordings

getRecordings(
requestParameters?: LiveTvApiGetRecordingsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4822

getRecordingsSeries

getRecordingsSeries(
requestParameters?: LiveTvApiGetRecordingsSeriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingsSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4835

getSchedulesDirectCountries

getSchedulesDirectCountries(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4846

getSeriesTimer

getSeriesTimer(
requestParameters: LiveTvApiGetSeriesTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4858

getSeriesTimers

getSeriesTimers(
requestParameters?: LiveTvApiGetSeriesTimersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SeriesTimerInfoDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetSeriesTimersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4870

getTimer

getTimer(
requestParameters: LiveTvApiGetTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TimerInfoDto, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4882

getTimers

getTimers(
requestParameters?: LiveTvApiGetTimersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TimerInfoDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetTimersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TimerInfoDtoQueryResult, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4894

getTunerHostTypes

getTunerHostTypes(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4905

resetTuner

resetTuner(
requestParameters: LiveTvApiResetTunerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiResetTunerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4917

setChannelMapping

setChannelMapping(
requestParameters: LiveTvApiSetChannelMappingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TunerChannelMapping, any>>
Parameters
- requestParameters: LiveTvApiSetChannelMappingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerChannelMapping, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4929

updateSeriesTimer

updateSeriesTimer(
requestParameters: LiveTvApiUpdateSeriesTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiUpdateSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4941

updateTimer

updateTimer(
requestParameters: LiveTvApiUpdateTimerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiUpdateTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4953

Class LiveTvApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LiveTvApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

addListingProvider

Parameters

Returns Promise<AxiosResponse<ListingsProviderInfo, any>>

Throws

Memberof

addTunerHost

Parameters

Returns Promise<AxiosResponse<TunerHostInfo, any>>

Throws

Memberof

cancelSeriesTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

cancelTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

createSeriesTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

createTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

deleteListingProvider

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

deleteRecording

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

deleteTunerHost

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

discoverTuners

Parameters

Returns Promise<AxiosResponse<TunerHostInfo[], any>>

Throws

Memberof

discvoverTuners

Parameters

Returns Promise<AxiosResponse<TunerHostInfo[], any>>

Throws

Memberof

getChannel

Parameters

Returns Promise<AxiosResponse<BaseItemDto, any>>

Throws

Memberof

getChannelMappingOptions

Parameters

Returns Promise<AxiosResponse<ChannelMappingOptionsDto, any>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration