jellyfin-api/org.jellyfin.sdk.api.operations/LiveTvApi

LiveTvApi

class LiveTvApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun addListingProvider(pw: String? = null, validateListings: Boolean? = false, validateLogin: Boolean? = false, data: ListingsProviderInfo? = null): Response<ListingsProviderInfo>

Adds a listings provider.

Link copied to clipboard
suspend fun addTunerHost(data: TunerHostInfo? = null): Response<TunerHostInfo>

Adds a tuner host.

Link copied to clipboard
suspend fun cancelSeriesTimer(timerId: String): Response<Unit>

Cancels a live tv series timer.

Link copied to clipboard
suspend fun cancelTimer(timerId: String): Response<Unit>

Cancels a live tv timer.

Link copied to clipboard
suspend fun createSeriesTimer(data: SeriesTimerInfoDto? = null): Response<Unit>

Creates a live tv series timer.

Link copied to clipboard
suspend fun createTimer(data: TimerInfoDto? = null): Response<Unit>

Creates a live tv timer.

Link copied to clipboard
suspend fun deleteListingProvider(id: String? = null): Response<Unit>

Delete listing provider.

Link copied to clipboard
suspend fun deleteRecording(recordingId: UUID): Response<Unit>

Deletes a live tv recording.

Link copied to clipboard
suspend fun deleteTunerHost(id: String? = null): Response<Unit>

Deletes a tuner host.

Link copied to clipboard
suspend fun discoverTuners(newDevicesOnly: Boolean? = false): Response<List<TunerHostInfo>>

Discover tuners.

Link copied to clipboard
suspend fun discvoverTuners(newDevicesOnly: Boolean? = false): Response<List<TunerHostInfo>>

Discover tuners.

Link copied to clipboard
suspend fun getChannel(channelId: UUID, userId: UUID? = null): Response<BaseItemDto>

Gets a live tv channel.

Link copied to clipboard
suspend fun getChannelMappingOptions(providerId: String? = null): Response<ChannelMappingOptionsDto>

Get channel mapping options.

Link copied to clipboard
suspend fun getDefaultListingProvider(): Response<ListingsProviderInfo>

Gets default listings provider info.

Link copied to clipboard
suspend fun getDefaultTimer(programId: String? = null): Response<SeriesTimerInfoDto>

Gets the default values for a new timer.

Link copied to clipboard
suspend fun getGuideInfo(): Response<GuideInfo>

Get guide info.

Link copied to clipboard
suspend fun getLineups(id: String? = null, type: String? = null, location: String? = null, country: String? = null): Response<List<NameIdPair>>

Gets available lineups.

Link copied to clipboard
suspend fun getLiveRecordingFile(recordingId: String): Response<ByteArray>

Gets a live tv recording stream.

Link copied to clipboard
fun getLiveRecordingFileUrl(recordingId: String): String

Gets a live tv recording stream.

Link copied to clipboard
suspend fun getLiveStreamFile(streamId: String, container: String): Response<ByteArray>

Gets a live tv channel stream.

Link copied to clipboard
fun getLiveStreamFileUrl(streamId: String, container: String): String

Gets a live tv channel stream.

Link copied to clipboard
suspend fun getLiveTvChannels(request: GetLiveTvChannelsRequest = GetLiveTvChannelsRequest()): Response<BaseItemDtoQueryResult>
suspend fun getLiveTvChannels(type: ChannelType? = null, userId: UUID? = null, startIndex: Int? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, limit: Int? = null, isFavorite: Boolean? = null, isLiked: Boolean? = null, isDisliked: Boolean? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), fields: Collection<ItemFields>? = emptyList(), enableUserData: Boolean? = null, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: SortOrder? = null, enableFavoriteSorting: Boolean? = false, addCurrentProgram: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets available live tv channels.

Link copied to clipboard
suspend fun getLiveTvInfo(): Response<LiveTvInfo>

Gets available live tv services.

Link copied to clipboard
suspend fun getLiveTvPrograms(request: GetLiveTvProgramsRequest = GetLiveTvProgramsRequest()): Response<BaseItemDtoQueryResult>
suspend fun getLiveTvPrograms(channelIds: Collection<UUID>? = emptyList(), userId: UUID? = null, minStartDate: DateTime? = null, hasAired: Boolean? = null, isAiring: Boolean? = null, maxStartDate: DateTime? = null, minEndDate: DateTime? = null, maxEndDate: DateTime? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, startIndex: Int? = null, limit: Int? = null, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<UUID>? = emptyList(), enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: UUID? = null, fields: Collection<ItemFields>? = emptyList(), enableTotalRecordCount: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets available live tv epgs.

Link copied to clipboard
suspend fun getProgram(programId: String, userId: UUID? = null): Response<BaseItemDto>

Gets a live tv program.

Link copied to clipboard
suspend fun getPrograms(data: GetProgramsDto? = null): Response<BaseItemDtoQueryResult>

Gets available live tv epgs.

Link copied to clipboard
suspend fun getRecommendedPrograms(request: GetRecommendedProgramsRequest = GetRecommendedProgramsRequest()): Response<BaseItemDtoQueryResult>
suspend fun getRecommendedPrograms(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, isAiring: Boolean? = null, hasAired: Boolean? = null, isSeries: Boolean? = null, isMovie: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), genreIds: Collection<UUID>? = emptyList(), fields: Collection<ItemFields>? = emptyList(), enableUserData: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets recommended live tv epgs.

Link copied to clipboard
suspend fun getRecording(recordingId: UUID, userId: UUID? = null): Response<BaseItemDto>

Gets a live tv recording.

Link copied to clipboard
suspend fun getRecordingFolders(userId: UUID? = null): Response<BaseItemDtoQueryResult>

Gets recording folders.

Link copied to clipboard
suspend fun getRecordingGroup(groupId: UUID): Response<Unit>

Get recording group.

Link copied to clipboard
suspend fun getRecordingGroups(userId: UUID? = null): Response<BaseItemDtoQueryResult>

Gets live tv recording groups.

Link copied to clipboard
suspend fun getRecordings(request: GetRecordingsRequest = GetRecordingsRequest()): Response<BaseItemDtoQueryResult>
suspend fun getRecordings(channelId: String? = null, userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, status: RecordingStatus? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), fields: Collection<ItemFields>? = emptyList(), enableUserData: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, isNews: Boolean? = null, isLibraryItem: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets live tv recordings.

Link copied to clipboard
suspend fun getRecordingsSeries(request: GetRecordingsSeriesRequest = GetRecordingsSeriesRequest()): Response<BaseItemDtoQueryResult>
suspend fun getRecordingsSeries(channelId: String? = null, userId: UUID? = null, groupId: String? = null, startIndex: Int? = null, limit: Int? = null, status: RecordingStatus? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), fields: Collection<ItemFields>? = emptyList(), enableUserData: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets live tv recording series.

Link copied to clipboard
suspend fun getSchedulesDirectCountries(): Response<ByteArray>

Gets available countries.

Link copied to clipboard
fun getSchedulesDirectCountriesUrl(): String

Gets available countries.

Link copied to clipboard
suspend fun getSeriesTimer(timerId: String): Response<SeriesTimerInfoDto>

Gets a live tv series timer.

Link copied to clipboard
suspend fun getSeriesTimers(sortBy: String? = null, sortOrder: SortOrder? = null): Response<SeriesTimerInfoDtoQueryResult>

Gets live tv series timers.

Link copied to clipboard
suspend fun getTimer(timerId: String): Response<TimerInfoDto>

Gets a timer.

Link copied to clipboard
suspend fun getTimers(channelId: String? = null, seriesTimerId: String? = null, isActive: Boolean? = null, isScheduled: Boolean? = null): Response<TimerInfoDtoQueryResult>

Gets the live tv timers.

Link copied to clipboard
suspend fun getTunerHostTypes(): Response<List<NameIdPair>>

Get tuner host types.

Link copied to clipboard
suspend fun resetTuner(tunerId: String): Response<Unit>

Resets a tv tuner.

Link copied to clipboard
suspend fun setChannelMapping(data: SetChannelMappingDto): Response<TunerChannelMapping>

Set channel mappings.

Link copied to clipboard
suspend fun updateSeriesTimer(timerId: String, data: SeriesTimerInfoDto? = null): Response<Unit>

Updates a live tv series timer.

Link copied to clipboard
suspend fun updateTimer(timerId: String, data: TimerInfoDto? = null): Response<Unit>

Updates a live tv timer.

Generated by Dokka
© 2026 Copyright