Class LiveTvApi

LiveTvApi - object-oriented interface

Export

LiveTvApi

Hierarchy

BaseAPI
- LiveTvApi

Constructors

constructor

new LiveTvApi(configuration?, basePath?, axios?): 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?, options?): Promise<AxiosResponse<ListingsProviderInfo, any>>
Parameters
- requestParameters: LiveTvApiAddListingProviderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListingsProviderInfo, any>>
Summary
Adds a listings provider.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4475

addTunerHost

addTunerHost(requestParameters?, options?): Promise<AxiosResponse<TunerHostInfo, any>>
Parameters
- requestParameters: LiveTvApiAddTunerHostRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo, any>>
Summary
Adds a tuner host.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4487

cancelSeriesTimer

cancelSeriesTimer(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCancelSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Cancels a live tv series timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4499

cancelTimer

cancelTimer(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCancelTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Cancels a live tv timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4511

createSeriesTimer

createSeriesTimer(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCreateSeriesTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Creates a live tv series timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4523

createTimer

createTimer(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiCreateTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Creates a live tv timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4535

deleteListingProvider

deleteListingProvider(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteListingProviderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Delete listing provider.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4547

deleteRecording

deleteRecording(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteRecordingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes a live tv recording.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4559

deleteTunerHost

deleteTunerHost(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiDeleteTunerHostRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes a tuner host.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4571

discoverTuners

discoverTuners(requestParameters?, options?): Promise<AxiosResponse<TunerHostInfo[], any>>
Parameters
- requestParameters: LiveTvApiDiscoverTunersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo[], any>>
Summary
Discover tuners.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4583

discvoverTuners

discvoverTuners(requestParameters?, options?): Promise<AxiosResponse<TunerHostInfo[], any>>
Parameters
- requestParameters: LiveTvApiDiscvoverTunersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerHostInfo[], any>>
Summary
Discover tuners.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4595

getChannel

getChannel(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetChannelRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Gets a live tv channel.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4607

getChannelMappingOptions

getChannelMappingOptions(requestParameters?, options?): Promise<AxiosResponse<ChannelMappingOptionsDto, any>>
Parameters
- requestParameters: LiveTvApiGetChannelMappingOptionsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelMappingOptionsDto, any>>
Summary
Get channel mapping options.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4619

getDefaultListingProvider

getDefaultListingProvider(options?): Promise<AxiosResponse<ListingsProviderInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListingsProviderInfo, any>>
Summary
Gets default listings provider info.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4630

getDefaultTimer

getDefaultTimer(requestParameters?, options?): Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetDefaultTimerRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Summary
Gets the default values for a new timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4642

getGuideInfo

getGuideInfo(options?): Promise<AxiosResponse<GuideInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuideInfo, any>>
Summary
Get guid info.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4653

getLineups

getLineups(requestParameters?, options?): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- requestParameters: LiveTvApiGetLineupsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Summary
Gets available lineups.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4665

getLiveRecordingFile

getLiveRecordingFile(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LiveTvApiGetLiveRecordingFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a live tv recording stream.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4677

getLiveStreamFile

getLiveStreamFile(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LiveTvApiGetLiveStreamFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a live tv channel stream.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4689

getLiveTvChannels

getLiveTvChannels(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetLiveTvChannelsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets available live tv channels.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4701

getLiveTvInfo

getLiveTvInfo(options?): Promise<AxiosResponse<LiveTvInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LiveTvInfo, any>>
Summary
Gets available live tv services.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4712

getLiveTvPrograms

getLiveTvPrograms(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetLiveTvProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets available live tv epgs.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4724

getProgram

getProgram(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetProgramRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Gets a live tv program.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4736

getPrograms

getPrograms(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets available live tv epgs.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4748

getRecommendedPrograms

getRecommendedPrograms(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecommendedProgramsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets recommended live tv epgs.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4760

getRecording

getRecording(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Gets a live tv recording.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4772

getRecordingFolders

getRecordingFolders(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingFoldersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets recording folders.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4784

getRecordingGroup

getRecordingGroup(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Get recording group.

Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4797

getRecordingGroups

getRecordingGroups(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingGroupsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets live tv recording groups.

Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4810

getRecordings

getRecordings(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets live tv recordings.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4822

getRecordingsSeries

getRecordingsSeries(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetRecordingsSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets live tv recording series.

Deprecated
Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4835

getSchedulesDirectCountries

getSchedulesDirectCountries(options?): Promise<AxiosResponse<File, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets available countries.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4846

getSeriesTimer

getSeriesTimer(requestParameters, options?): Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDto, any>>
Summary
Gets a live tv series timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4858

getSeriesTimers

getSeriesTimers(requestParameters?, options?): Promise<AxiosResponse<SeriesTimerInfoDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetSeriesTimersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeriesTimerInfoDtoQueryResult, any>>
Summary
Gets live tv series timers.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4870

getTimer

getTimer(requestParameters, options?): Promise<AxiosResponse<TimerInfoDto, any>>
Parameters
- requestParameters: LiveTvApiGetTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TimerInfoDto, any>>
Summary
Gets a timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4882

getTimers

getTimers(requestParameters?, options?): Promise<AxiosResponse<TimerInfoDtoQueryResult, any>>
Parameters
- requestParameters: LiveTvApiGetTimersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TimerInfoDtoQueryResult, any>>
Summary
Gets the live tv timers.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4894

getTunerHostTypes

getTunerHostTypes(options?): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Summary
Get tuner host types.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4905

resetTuner

resetTuner(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiResetTunerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Resets a tv tuner.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4917

setChannelMapping

setChannelMapping(requestParameters, options?): Promise<AxiosResponse<TunerChannelMapping, any>>
Parameters
- requestParameters: LiveTvApiSetChannelMappingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TunerChannelMapping, any>>
Summary
Set channel mappings.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4929

updateSeriesTimer

updateSeriesTimer(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiUpdateSeriesTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a live tv series timer.

Throws
Memberof
LiveTvApi
- Defined in generated-client/api/live-tv-api.ts:4941

updateTimer

updateTimer(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LiveTvApiUpdateTimerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a live tv timer.

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

Summary

Throws

Memberof

addTunerHost

Parameters

Returns Promise<AxiosResponse<TunerHostInfo, any>>

Summary

Throws

Memberof

cancelSeriesTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

cancelTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

createSeriesTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

createTimer

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteListingProvider

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteRecording

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteTunerHost

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

discoverTuners

Parameters

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

Summary

Throws

Memberof

discvoverTuners

Parameters

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

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration