Function LiveTvApiAxiosParamCreator

Returns {
    addListingProvider: ((pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    addTunerHost: ((tunerHostInfo?: TunerHostInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    cancelSeriesTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    cancelTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createSeriesTimer: ((seriesTimerInfoDto?: SeriesTimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createTimer: ((timerInfoDto?: TimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteListingProvider: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteRecording: ((recordingId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteTunerHost: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    discoverTuners: ((newDevicesOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    discvoverTuners: ((newDevicesOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getChannel: ((channelId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getChannelMappingOptions: ((providerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getDefaultListingProvider: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getDefaultTimer: ((programId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getGuideInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getLineups: ((id?: string, type?: string, location?: string, country?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getLiveRecordingFile: ((recordingId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getLiveStreamFile: ((streamId: string, container: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    getLiveTvInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    getProgram: ((programId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPrograms: ((getProgramsDto?: GetProgramsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    getRecording: ((recordingId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getRecordingFolders: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getRecordingGroup: ((groupId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getRecordingGroups: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    getSchedulesDirectCountries: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getSeriesTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getSeriesTimers: ((sortBy?: string, sortOrder?: SortOrder, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getTimers: ((channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getTunerHostTypes: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    resetTuner: ((tunerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    setChannelMapping: ((setChannelMappingDto: SetChannelMappingDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateSeriesTimer: ((timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateTimer: ((timerId: string, timerInfoDto?: TimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• addListingProvider: ((pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Adds a listings provider.

  Throws

  • • (pw?, validateListings?, validateLogin?, listingsProviderInfo?, options?): Promise<RequestArgs>

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

• addTunerHost: ((tunerHostInfo?: TunerHostInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Adds a tuner host.

  Throws

  • • (tunerHostInfo?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltunerHostInfo: TunerHostInfo

        New tuner host.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• cancelSeriesTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Cancels a live tv series timer.

  Throws

  • • (timerId, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• cancelTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Cancels a live tv timer.

  Throws

  • • (timerId, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createSeriesTimer: ((seriesTimerInfoDto?: SeriesTimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Creates a live tv series timer.

  Throws

  • • (seriesTimerInfoDto?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalseriesTimerInfoDto: SeriesTimerInfoDto

        New series timer info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createTimer: ((timerInfoDto?: TimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Creates a live tv timer.

  Throws

  • • (timerInfoDto?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltimerInfoDto: TimerInfoDto

        New timer info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteListingProvider: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Delete listing provider.

  Throws

  • • (id?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalid: string

        Listing provider id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteRecording: ((recordingId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Deletes a live tv recording.

  Throws

  • • (recordingId, options?): Promise<RequestArgs>

    • Parameters

      • recordingId: string

        Recording id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteTunerHost: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Deletes a tuner host.

  Throws

  • • (id?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalid: string

        Tuner host id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• discoverTuners: ((newDevicesOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Discover tuners.

  Throws

  • • (newDevicesOnly?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalnewDevicesOnly: boolean

        Only discover new tuners.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• discvoverTuners: ((newDevicesOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Discover tuners.

  Throws

  • • (newDevicesOnly?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalnewDevicesOnly: boolean

        Only discover new tuners.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getChannel: ((channelId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv channel.

  Throws

  • • (channelId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • channelId: string

        Channel id.
      • OptionaluserId: string

        Optional. Attach user data.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getChannelMappingOptions: ((providerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get channel mapping options.

  Throws

  • • (providerId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalproviderId: string

        Provider id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getDefaultListingProvider: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets default listings provider info.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getDefaultTimer: ((programId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the default values for a new timer.

  Throws

  • • (programId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalprogramId: string

        Optional. To attach default values based on a program.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getGuideInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get guid info.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getLineups: ((id?: string, type?: string, location?: string, country?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets available lineups.

  Throws

  • • (id?, type?, location?, country?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalid: string

        Provider id.
      • Optionaltype: string

        Provider type.
      • Optionallocation: string

        Location.
      • Optionalcountry: string

        Country.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getLiveRecordingFile: ((recordingId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv recording stream.

  Throws

  • • (recordingId, options?): Promise<RequestArgs>

    • Parameters

      • recordingId: string

        Recording id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getLiveStreamFile: ((streamId: string, container: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv channel stream.

  Throws

  • • (streamId, container, options?): Promise<RequestArgs>

    • Parameters

      • streamId: string

        Stream id.
      • container: string

        Container type.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets available live tv channels.

  Throws

  • • (type?, userId?, startIndex?, isMovie?, isSeries?, isNews?, isKids?, isSports?, limit?, isFavorite?, isLiked?, isDisliked?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, sortBy?, sortOrder?, enableFavoriteSorting?, addCurrentProgram?, options?): Promise<RequestArgs>

    • 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[]

        &quot;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<RequestArgs>

• getLiveTvInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets available live tv services.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets available live tv epgs.

  Throws

  • • (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<RequestArgs>

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

• getProgram: ((programId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv program.

  Throws

  • • (programId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • programId: string

        Program id.
      • OptionaluserId: string

        Optional. Attach user data.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPrograms: ((getProgramsDto?: GetProgramsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets available live tv epgs.

  Throws

  • • (getProgramsDto?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalgetProgramsDto: GetProgramsDto

        Request body.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets recommended live tv epgs.

  Throws

  • • (userId?, limit?, isAiring?, hasAired?, isSeries?, isMovie?, isNews?, isKids?, isSports?, enableImages?, imageTypeLimit?, enableImageTypes?, genreIds?, fields?, enableUserData?, enableTotalRecordCount?, options?): Promise<RequestArgs>

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

• getRecording: ((recordingId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv recording.

  Throws

  • • (recordingId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • recordingId: string

        Recording id.
      • OptionaluserId: string

        Optional. Attach user data.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getRecordingFolders: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets recording folders.

  Throws

  • • (userId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaluserId: string

        Optional. Filter by user and attach user data.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getRecordingGroup: ((groupId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get recording group.

  Deprecated

  Throws

  • • (groupId, options?): Promise<RequestArgs>

    • Parameters

      • groupId: string

        Group id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getRecordingGroups: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets live tv recording groups.

  Deprecated

  Throws

  • • (userId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaluserId: string

        Optional. Filter by user and attach user data.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets live tv recordings.

  Throws

  • • (channelId?, userId?, startIndex?, limit?, status?, isInProgress?, seriesTimerId?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, isMovie?, isSeries?, isKids?, isSports?, isNews?, isLibraryItem?, enableTotalRecordCount?, options?): Promise<RequestArgs>

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

• 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<RequestArgs>)

  Summary

  Gets live tv recording series.

  Deprecated

  Throws

  • • (channelId?, userId?, groupId?, startIndex?, limit?, status?, isInProgress?, seriesTimerId?, enableImages?, imageTypeLimit?, enableImageTypes?, fields?, enableUserData?, enableTotalRecordCount?, options?): Promise<RequestArgs>

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

• getSchedulesDirectCountries: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets available countries.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSeriesTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a live tv series timer.

  Throws

  • • (timerId, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSeriesTimers: ((sortBy?: string, sortOrder?: SortOrder, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets live tv series timers.

  Throws

  • • (sortBy?, sortOrder?, options?): Promise<RequestArgs>

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

• getTimer: ((timerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a timer.

  Throws

  • • (timerId, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getTimers: ((channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the live tv timers.

  Throws

  • • (channelId?, seriesTimerId?, isActive?, isScheduled?, options?): Promise<RequestArgs>

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

• getTunerHostTypes: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get tuner host types.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• resetTuner: ((tunerId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Resets a tv tuner.

  Throws

  • • (tunerId, options?): Promise<RequestArgs>

    • Parameters

      • tunerId: string

        Tuner id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• setChannelMapping: ((setChannelMappingDto: SetChannelMappingDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Set channel mappings.

  Throws

  • • (setChannelMappingDto, options?): Promise<RequestArgs>

    • Parameters

      • setChannelMappingDto: SetChannelMappingDto

        The set channel mapping dto.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateSeriesTimer: ((timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a live tv series timer.

  Throws

  • • (timerId, seriesTimerInfoDto?, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • OptionalseriesTimerInfoDto: SeriesTimerInfoDto

        New series timer info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateTimer: ((timerId: string, timerInfoDto?: TimerInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a live tv timer.

  Throws

  • • (timerId, timerInfoDto?, options?): Promise<RequestArgs>

    • Parameters

      • timerId: string

        Timer id.
      • OptionaltimerInfoDto: TimerInfoDto

        New timer info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>