@jellyfin/sdk
    Preparing search index...

    Function LiveTvApiAxiosParamCreator

    • LiveTvApi - axios parameter creator

      Parameters

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