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: ERROR CLASS: Symbol not found for ListingsProviderInfo?? = null): Response<ERROR CLASS: Symbol not found for ListingsProviderInfo>

Adds a listings provider.

Link copied to clipboard
suspend fun addTunerHost(data: ERROR CLASS: Symbol not found for TunerHostInfo?? = null): Response<ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for SeriesTimerInfoDto?? = null): Response<Unit>

Creates a live tv series timer.

Link copied to clipboard
suspend fun createTimer(data: ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for TunerHostInfo>>

Discover tuners.

Link copied to clipboard
suspend fun discvoverTuners(newDevicesOnly: Boolean? = false): Response<List<ERROR CLASS: Symbol not found for TunerHostInfo>>

Discover tuners.

Link copied to clipboard
suspend fun getChannel(channelId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDto>

Gets a live tv channel.

Link copied to clipboard
suspend fun getChannelMappingOptions(providerId: String? = null): Response<ERROR CLASS: Symbol not found for ChannelMappingOptionsDto>

Get channel mapping options.

Link copied to clipboard
suspend fun getDefaultListingProvider(): Response<ERROR CLASS: Symbol not found for ListingsProviderInfo>

Gets default listings provider info.

Link copied to clipboard
suspend fun getDefaultTimer(programId: String? = null): Response<ERROR CLASS: Symbol not found for SeriesTimerInfoDto>

Gets the default values for a new timer.

Link copied to clipboard
suspend fun getGuideInfo(): Response<ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for GetLiveTvChannelsRequest = GetLiveTvChannelsRequest()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getLiveTvChannels(type: ERROR CLASS: Symbol not found for ChannelType?? = null, userId: ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList(), enableUserData: Boolean? = null, sortBy: Collection<ERROR CLASS: Symbol not found for ItemSortBy>? = emptyList(), sortOrder: ERROR CLASS: Symbol not found for SortOrder?? = null, enableFavoriteSorting: Boolean? = false, addCurrentProgram: Boolean? = true): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets available live tv channels.

Link copied to clipboard
suspend fun getLiveTvInfo(): Response<ERROR CLASS: Symbol not found for LiveTvInfo>

Gets available live tv services.

Link copied to clipboard
suspend fun getLiveTvPrograms(request: ERROR CLASS: Symbol not found for GetLiveTvProgramsRequest = GetLiveTvProgramsRequest()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getLiveTvPrograms(channelIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, minStartDate: ERROR CLASS: Symbol not found for DateTime?? = null, hasAired: Boolean? = null, isAiring: Boolean? = null, maxStartDate: ERROR CLASS: Symbol not found for DateTime?? = null, minEndDate: ERROR CLASS: Symbol not found for DateTime?? = null, maxEndDate: ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for ItemSortBy>? = emptyList(), sortOrder: Collection<ERROR CLASS: Symbol not found for SortOrder>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: ERROR CLASS: Symbol not found for UUID?? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList(), enableTotalRecordCount: Boolean? = true): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets available live tv epgs.

Link copied to clipboard
suspend fun getProgram(programId: String, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDto>

Gets a live tv program.

Link copied to clipboard
suspend fun getPrograms(data: ERROR CLASS: Symbol not found for GetProgramsDto?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets available live tv epgs.

Link copied to clipboard
suspend fun getRecommendedPrograms(request: ERROR CLASS: Symbol not found for GetRecommendedProgramsRequest = GetRecommendedProgramsRequest()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getRecommendedPrograms(userId: ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), genreIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList(), enableUserData: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets recommended live tv epgs.

Link copied to clipboard
suspend fun getRecording(recordingId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDto>

Gets a live tv recording.

Link copied to clipboard
suspend fun getRecordingFolders(userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets recording folders.

Link copied to clipboard
suspend fun getRecordingGroup(groupId: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Get recording group.

Link copied to clipboard
suspend fun getRecordingGroups(userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets live tv recording groups.

Link copied to clipboard
suspend fun getRecordings(request: ERROR CLASS: Symbol not found for GetRecordingsRequest = GetRecordingsRequest()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getRecordings(channelId: String? = null, userId: ERROR CLASS: Symbol not found for UUID?? = null, startIndex: Int? = null, limit: Int? = null, status: ERROR CLASS: Symbol not found for RecordingStatus?? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), fields: Collection<ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets live tv recordings.

Link copied to clipboard
suspend fun getRecordingsSeries(request: ERROR CLASS: Symbol not found for GetRecordingsSeriesRequest = GetRecordingsSeriesRequest()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getRecordingsSeries(channelId: String? = null, userId: ERROR CLASS: Symbol not found for UUID?? = null, groupId: String? = null, startIndex: Int? = null, limit: Int? = null, status: ERROR CLASS: Symbol not found for RecordingStatus?? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList(), enableUserData: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<ERROR CLASS: Symbol not found for 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<ERROR CLASS: Symbol not found for SeriesTimerInfoDto>

Gets a live tv series timer.

Link copied to clipboard
suspend fun getSeriesTimers(sortBy: String? = null, sortOrder: ERROR CLASS: Symbol not found for SortOrder?? = null): Response<ERROR CLASS: Symbol not found for SeriesTimerInfoDtoQueryResult>

Gets live tv series timers.

Link copied to clipboard
suspend fun getTimer(timerId: String): Response<ERROR CLASS: Symbol not found for TimerInfoDto>

Gets a timer.

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

Gets the live tv timers.

Link copied to clipboard
suspend fun getTunerHostTypes(): Response<List<ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for SetChannelMappingDto): Response<ERROR CLASS: Symbol not found for TunerChannelMapping>

Set channel mappings.

Link copied to clipboard
suspend fun updateSeriesTimer(timerId: String, data: ERROR CLASS: Symbol not found for SeriesTimerInfoDto?? = null): Response<Unit>

Updates a live tv series timer.

Link copied to clipboard
suspend fun updateTimer(timerId: String, data: ERROR CLASS: Symbol not found for TimerInfoDto?? = null): Response<Unit>

Updates a live tv timer.

Generated by Dokka
© 2026 Copyright