commonMain.org.jellyfin.sdk.api.operations.LiveTvApi.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jellyfin-api-jvm Show documentation
Show all versions of jellyfin-api-jvm Show documentation
Official Kotlin/Java SDK for Jellyfin. org.jellyfin.sdk:jellyfin-api-jvm
// !! WARNING
// !! DO NOT EDIT THIS FILE
//
// This file is generated by the openapi-generator module and is not meant for manual changes.
// Please read the README.md file in the openapi-generator module for additional information.
package org.jellyfin.sdk.api.operations
import io.ktor.utils.io.ByteReadChannel
import kotlin.Any
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.Int
import kotlin.String
import kotlin.Unit
import kotlin.collections.Collection
import kotlin.collections.List
import kotlin.collections.buildMap
import kotlin.collections.emptyList
import kotlin.collections.emptyMap
import org.jellyfin.sdk.api.client.ApiClient
import org.jellyfin.sdk.api.client.Response
import org.jellyfin.sdk.api.client.extensions.`get`
import org.jellyfin.sdk.api.client.extensions.delete
import org.jellyfin.sdk.api.client.extensions.post
import org.jellyfin.sdk.model.DateTime
import org.jellyfin.sdk.model.UUID
import org.jellyfin.sdk.model.api.BaseItemDto
import org.jellyfin.sdk.model.api.BaseItemDtoQueryResult
import org.jellyfin.sdk.model.api.ChannelMappingOptionsDto
import org.jellyfin.sdk.model.api.ChannelType
import org.jellyfin.sdk.model.api.GetProgramsDto
import org.jellyfin.sdk.model.api.GuideInfo
import org.jellyfin.sdk.model.api.ImageType
import org.jellyfin.sdk.model.api.ItemFields
import org.jellyfin.sdk.model.api.ItemSortBy
import org.jellyfin.sdk.model.api.ListingsProviderInfo
import org.jellyfin.sdk.model.api.LiveTvInfo
import org.jellyfin.sdk.model.api.NameIdPair
import org.jellyfin.sdk.model.api.RecordingStatus
import org.jellyfin.sdk.model.api.SeriesTimerInfoDto
import org.jellyfin.sdk.model.api.SeriesTimerInfoDtoQueryResult
import org.jellyfin.sdk.model.api.SetChannelMappingDto
import org.jellyfin.sdk.model.api.SortOrder
import org.jellyfin.sdk.model.api.TimerInfoDto
import org.jellyfin.sdk.model.api.TimerInfoDtoQueryResult
import org.jellyfin.sdk.model.api.TunerChannelMapping
import org.jellyfin.sdk.model.api.TunerHostInfo
import org.jellyfin.sdk.model.api.request.GetLiveTvChannelsRequest
import org.jellyfin.sdk.model.api.request.GetLiveTvProgramsRequest
import org.jellyfin.sdk.model.api.request.GetRecommendedProgramsRequest
import org.jellyfin.sdk.model.api.request.GetRecordingsRequest
import org.jellyfin.sdk.model.api.request.GetRecordingsSeriesRequest
public class LiveTvApi(
private val api: ApiClient,
) : Api {
/**
* Adds a listings provider.
*
* @param pw Password.
* @param validateListings Validate listings.
* @param validateLogin Validate login.
*/
public suspend fun addListingProvider(
pw: String? = null,
validateListings: Boolean? = false,
validateLogin: Boolean? = false,
`data`: ListingsProviderInfo? = null,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(3) {
put("pw", pw)
put("validateListings", validateListings)
put("validateLogin", validateLogin)
}
val response = api.post("/LiveTv/ListingProviders", pathParameters,
queryParameters, data)
return response
}
/**
* Adds a tuner host.
*/
public suspend fun addTunerHost(`data`: TunerHostInfo? = null): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val response = api.post("/LiveTv/TunerHosts", pathParameters, queryParameters,
data)
return response
}
/**
* Cancels a live tv series timer.
*
* @param timerId Timer id.
*/
public suspend fun cancelSeriesTimer(timerId: String): Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val data = null
val response = api.delete("/LiveTv/SeriesTimers/{timerId}", pathParameters, queryParameters,
data)
return response
}
/**
* Cancels a live tv timer.
*
* @param timerId Timer id.
*/
public suspend fun cancelTimer(timerId: String): Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val data = null
val response = api.delete("/LiveTv/Timers/{timerId}", pathParameters, queryParameters, data)
return response
}
/**
* Creates a live tv series timer.
*/
public suspend fun createSeriesTimer(`data`: SeriesTimerInfoDto? = null): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val response = api.post("/LiveTv/SeriesTimers", pathParameters, queryParameters, data)
return response
}
/**
* Creates a live tv timer.
*/
public suspend fun createTimer(`data`: TimerInfoDto? = null): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val response = api.post("/LiveTv/Timers", pathParameters, queryParameters, data)
return response
}
/**
* Delete listing provider.
*
* @param id Listing provider id.
*/
public suspend fun deleteListingProvider(id: String? = null): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("id", id)
}
val data = null
val response = api.delete("/LiveTv/ListingProviders", pathParameters, queryParameters, data)
return response
}
/**
* Deletes a live tv recording.
*
* @param recordingId Recording id.
*/
public suspend fun deleteRecording(recordingId: UUID): Response {
val pathParameters = buildMap(1) {
put("recordingId", recordingId)
}
val queryParameters = emptyMap()
val data = null
val response = api.delete("/LiveTv/Recordings/{recordingId}", pathParameters,
queryParameters, data)
return response
}
/**
* Deletes a tuner host.
*
* @param id Tuner host id.
*/
public suspend fun deleteTunerHost(id: String? = null): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("id", id)
}
val data = null
val response = api.delete("/LiveTv/TunerHosts", pathParameters, queryParameters, data)
return response
}
/**
* Discover tuners.
*
* @param newDevicesOnly Only discover new tuners.
*/
public suspend fun discoverTuners(newDevicesOnly: Boolean? = false):
Response> {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("newDevicesOnly", newDevicesOnly)
}
val data = null
val response = api.`get`>("/LiveTv/Tuners/Discover", pathParameters,
queryParameters, data)
return response
}
/**
* Discover tuners.
*
* @param newDevicesOnly Only discover new tuners.
*/
public suspend fun discvoverTuners(newDevicesOnly: Boolean? = false):
Response> {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("newDevicesOnly", newDevicesOnly)
}
val data = null
val response = api.`get`>("/LiveTv/Tuners/Discvover", pathParameters,
queryParameters, data)
return response
}
/**
* Gets a live tv channel.
*
* @param channelId Channel id.
* @param userId Optional. Attach user data.
*/
public suspend fun getChannel(channelId: UUID, userId: UUID? = null): Response {
val pathParameters = buildMap(1) {
put("channelId", channelId)
}
val queryParameters = buildMap(1) {
put("userId", userId)
}
val data = null
val response = api.`get`("/LiveTv/Channels/{channelId}", pathParameters,
queryParameters, data)
return response
}
/**
* Get channel mapping options.
*
* @param providerId Provider id.
*/
public suspend fun getChannelMappingOptions(providerId: String? = null):
Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("providerId", providerId)
}
val data = null
val response = api.`get`("/LiveTv/ChannelMappingOptions",
pathParameters, queryParameters, data)
return response
}
/**
* Gets default listings provider info.
*/
public suspend fun getDefaultListingProvider(): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/ListingProviders/Default", pathParameters,
queryParameters, data)
return response
}
/**
* Gets the default values for a new timer.
*
* @param programId Optional. To attach default values based on a program.
*/
public suspend fun getDefaultTimer(programId: String? = null): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("programId", programId)
}
val data = null
val response = api.`get`("/LiveTv/Timers/Defaults", pathParameters,
queryParameters, data)
return response
}
/**
* Get guid info.
*/
public suspend fun getGuideInfo(): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/GuideInfo", pathParameters, queryParameters, data)
return response
}
/**
* Gets available lineups.
*
* @param id Provider id.
* @param type Provider type.
* @param location Location.
* @param country Country.
*/
public suspend fun getLineups(
id: String? = null,
type: String? = null,
location: String? = null,
country: String? = null,
): Response> {
val pathParameters = emptyMap()
val queryParameters = buildMap(4) {
put("id", id)
put("type", type)
put("location", location)
put("country", country)
}
val data = null
val response = api.`get`>("/LiveTv/ListingProviders/Lineups", pathParameters,
queryParameters, data)
return response
}
/**
* Gets a live tv recording stream.
*
* @param recordingId Recording id.
*/
public suspend fun getLiveRecordingFile(recordingId: String): Response {
val pathParameters = buildMap(1) {
put("recordingId", recordingId)
}
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/LiveRecordings/{recordingId}/stream",
pathParameters, queryParameters, data)
return response
}
/**
* Gets a live tv recording stream.
*
* @param recordingId Recording id.
*/
public fun getLiveRecordingFileUrl(recordingId: String): String {
val pathParameters = buildMap(1) {
put("recordingId", recordingId)
}
val queryParameters = emptyMap()
return api.createUrl("/LiveTv/LiveRecordings/{recordingId}/stream", pathParameters,
queryParameters)
}
/**
* Gets a live tv channel stream.
*
* @param streamId Stream id.
* @param container Container type.
*/
public suspend fun getLiveStreamFile(streamId: String, container: String):
Response {
val pathParameters = buildMap(2) {
put("streamId", streamId)
put("container", container)
}
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/LiveStreamFiles/{streamId}/stream.{container}",
pathParameters, queryParameters, data)
return response
}
/**
* Gets a live tv channel stream.
*
* @param streamId Stream id.
* @param container Container type.
*/
public fun getLiveStreamFileUrl(streamId: String, container: String): String {
val pathParameters = buildMap(2) {
put("streamId", streamId)
put("container", container)
}
val queryParameters = emptyMap()
return api.createUrl("/LiveTv/LiveStreamFiles/{streamId}/stream.{container}", pathParameters,
queryParameters)
}
/**
* Gets available live tv channels.
*
* @param type Optional. Filter by channel type.
* @param userId Optional. Filter by user and attach user data.
* @param startIndex Optional. The record index to start at. All items with a lower index will be
* dropped from the results.
* @param isMovie Optional. Filter for movies.
* @param isSeries Optional. Filter for series.
* @param isNews Optional. Filter for news.
* @param isKids Optional. Filter for kids.
* @param isSports Optional. Filter for sports.
* @param limit Optional. The maximum number of records to return.
* @param isFavorite Optional. Filter by channels that are favorites, or not.
* @param isLiked Optional. Filter by channels that are liked, or not.
* @param isDisliked Optional. Filter by channels that are disliked, or not.
* @param enableImages Optional. Include image information in output.
* @param imageTypeLimit Optional. The max number of images to return, per image type.
* @param enableImageTypes "Optional. The image types to include in the output.
* @param fields Optional. Specify additional fields of information to return in the output.
* @param enableUserData Optional. Include user data.
* @param sortBy Optional. Key to sort by.
* @param sortOrder Optional. Sort order.
* @param enableFavoriteSorting Optional. Incorporate favorite and like status into channel
* sorting.
* @param addCurrentProgram Optional. Adds current program info to each channel.
*/
public 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? = emptyList(),
fields: Collection? = emptyList(),
enableUserData: Boolean? = null,
sortBy: Collection? = emptyList(),
sortOrder: SortOrder? = null,
enableFavoriteSorting: Boolean? = false,
addCurrentProgram: Boolean? = true,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(21) {
put("type", type)
put("userId", userId)
put("startIndex", startIndex)
put("isMovie", isMovie)
put("isSeries", isSeries)
put("isNews", isNews)
put("isKids", isKids)
put("isSports", isSports)
put("limit", limit)
put("isFavorite", isFavorite)
put("isLiked", isLiked)
put("isDisliked", isDisliked)
put("enableImages", enableImages)
put("imageTypeLimit", imageTypeLimit)
put("enableImageTypes", enableImageTypes)
put("fields", fields)
put("enableUserData", enableUserData)
put("sortBy", sortBy)
put("sortOrder", sortOrder)
put("enableFavoriteSorting", enableFavoriteSorting)
put("addCurrentProgram", addCurrentProgram)
}
val data = null
val response = api.`get`("/LiveTv/Channels", pathParameters,
queryParameters, data)
return response
}
/**
* Gets available live tv channels.
*
* @param request The request parameters
*/
public suspend fun getLiveTvChannels(request: GetLiveTvChannelsRequest =
GetLiveTvChannelsRequest()): Response = getLiveTvChannels(
type = request.type,
userId = request.userId,
startIndex = request.startIndex,
isMovie = request.isMovie,
isSeries = request.isSeries,
isNews = request.isNews,
isKids = request.isKids,
isSports = request.isSports,
limit = request.limit,
isFavorite = request.isFavorite,
isLiked = request.isLiked,
isDisliked = request.isDisliked,
enableImages = request.enableImages,
imageTypeLimit = request.imageTypeLimit,
enableImageTypes = request.enableImageTypes,
fields = request.fields,
enableUserData = request.enableUserData,
sortBy = request.sortBy,
sortOrder = request.sortOrder,
enableFavoriteSorting = request.enableFavoriteSorting,
addCurrentProgram = request.addCurrentProgram,
)
/**
* Gets available live tv services.
*/
public suspend fun getLiveTvInfo(): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/Info", pathParameters, queryParameters, data)
return response
}
/**
* Gets available live tv epgs.
*
* @param channelIds The channels to return guide information for.
* @param userId Optional. Filter by user id.
* @param minStartDate Optional. The minimum premiere start date.
* @param hasAired Optional. Filter by programs that have completed airing, or not.
* @param isAiring Optional. Filter by programs that are currently airing, or not.
* @param maxStartDate Optional. The maximum premiere start date.
* @param minEndDate Optional. The minimum premiere end date.
* @param maxEndDate Optional. The maximum premiere end date.
* @param isMovie Optional. Filter for movies.
* @param isSeries Optional. Filter for series.
* @param isNews Optional. Filter for news.
* @param isKids Optional. Filter for kids.
* @param isSports Optional. Filter for sports.
* @param startIndex Optional. The record index to start at. All items with a lower index will be
* dropped from the results.
* @param limit Optional. The maximum number of records to return.
* @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Name,
* StartDate.
* @param sortOrder Sort Order - Ascending,Descending.
* @param genres The genres to return guide information for.
* @param genreIds The genre ids to return guide information for.
* @param enableImages Optional. Include image information in output.
* @param imageTypeLimit Optional. The max number of images to return, per image type.
* @param enableImageTypes Optional. The image types to include in the output.
* @param enableUserData Optional. Include user data.
* @param seriesTimerId Optional. Filter by series timer id.
* @param librarySeriesId Optional. Filter by library series id.
* @param fields Optional. Specify additional fields of information to return in the output.
* @param enableTotalRecordCount Retrieve total record count.
*/
public suspend fun getLiveTvPrograms(
channelIds: Collection? = 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? = emptyList(),
sortOrder: Collection? = emptyList(),
genres: Collection? = emptyList(),
genreIds: Collection? = emptyList(),
enableImages: Boolean? = null,
imageTypeLimit: Int? = null,
enableImageTypes: Collection? = emptyList(),
enableUserData: Boolean? = null,
seriesTimerId: String? = null,
librarySeriesId: UUID? = null,
fields: Collection? = emptyList(),
enableTotalRecordCount: Boolean? = true,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(27) {
put("channelIds", channelIds)
put("userId", userId)
put("minStartDate", minStartDate)
put("hasAired", hasAired)
put("isAiring", isAiring)
put("maxStartDate", maxStartDate)
put("minEndDate", minEndDate)
put("maxEndDate", maxEndDate)
put("isMovie", isMovie)
put("isSeries", isSeries)
put("isNews", isNews)
put("isKids", isKids)
put("isSports", isSports)
put("startIndex", startIndex)
put("limit", limit)
put("sortBy", sortBy)
put("sortOrder", sortOrder)
put("genres", genres)
put("genreIds", genreIds)
put("enableImages", enableImages)
put("imageTypeLimit", imageTypeLimit)
put("enableImageTypes", enableImageTypes)
put("enableUserData", enableUserData)
put("seriesTimerId", seriesTimerId)
put("librarySeriesId", librarySeriesId)
put("fields", fields)
put("enableTotalRecordCount", enableTotalRecordCount)
}
val data = null
val response = api.`get`("/LiveTv/Programs", pathParameters,
queryParameters, data)
return response
}
/**
* Gets available live tv epgs.
*
* @param request The request parameters
*/
public suspend fun getLiveTvPrograms(request: GetLiveTvProgramsRequest =
GetLiveTvProgramsRequest()): Response = getLiveTvPrograms(
channelIds = request.channelIds,
userId = request.userId,
minStartDate = request.minStartDate,
hasAired = request.hasAired,
isAiring = request.isAiring,
maxStartDate = request.maxStartDate,
minEndDate = request.minEndDate,
maxEndDate = request.maxEndDate,
isMovie = request.isMovie,
isSeries = request.isSeries,
isNews = request.isNews,
isKids = request.isKids,
isSports = request.isSports,
startIndex = request.startIndex,
limit = request.limit,
sortBy = request.sortBy,
sortOrder = request.sortOrder,
genres = request.genres,
genreIds = request.genreIds,
enableImages = request.enableImages,
imageTypeLimit = request.imageTypeLimit,
enableImageTypes = request.enableImageTypes,
enableUserData = request.enableUserData,
seriesTimerId = request.seriesTimerId,
librarySeriesId = request.librarySeriesId,
fields = request.fields,
enableTotalRecordCount = request.enableTotalRecordCount,
)
/**
* Gets a live tv program.
*
* @param programId Program id.
* @param userId Optional. Attach user data.
*/
public suspend fun getProgram(programId: String, userId: UUID? = null): Response {
val pathParameters = buildMap(1) {
put("programId", programId)
}
val queryParameters = buildMap(1) {
put("userId", userId)
}
val data = null
val response = api.`get`("/LiveTv/Programs/{programId}", pathParameters,
queryParameters, data)
return response
}
/**
* Gets available live tv epgs.
*/
public suspend fun getPrograms(`data`: GetProgramsDto? = null): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val response = api.post("/LiveTv/Programs", pathParameters,
queryParameters, data)
return response
}
/**
* Gets recommended live tv epgs.
*
* @param userId Optional. filter by user id.
* @param limit Optional. The maximum number of records to return.
* @param isAiring Optional. Filter by programs that are currently airing, or not.
* @param hasAired Optional. Filter by programs that have completed airing, or not.
* @param isSeries Optional. Filter for series.
* @param isMovie Optional. Filter for movies.
* @param isNews Optional. Filter for news.
* @param isKids Optional. Filter for kids.
* @param isSports Optional. Filter for sports.
* @param enableImages Optional. Include image information in output.
* @param imageTypeLimit Optional. The max number of images to return, per image type.
* @param enableImageTypes Optional. The image types to include in the output.
* @param genreIds The genres to return guide information for.
* @param fields Optional. Specify additional fields of information to return in the output.
* @param enableUserData Optional. include user data.
* @param enableTotalRecordCount Retrieve total record count.
*/
public suspend fun getRecommendedPrograms(
userId: UUID? = 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? = emptyList(),
genreIds: Collection? = emptyList(),
fields: Collection? = emptyList(),
enableUserData: Boolean? = null,
enableTotalRecordCount: Boolean? = true,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(16) {
put("userId", userId)
put("limit", limit)
put("isAiring", isAiring)
put("hasAired", hasAired)
put("isSeries", isSeries)
put("isMovie", isMovie)
put("isNews", isNews)
put("isKids", isKids)
put("isSports", isSports)
put("enableImages", enableImages)
put("imageTypeLimit", imageTypeLimit)
put("enableImageTypes", enableImageTypes)
put("genreIds", genreIds)
put("fields", fields)
put("enableUserData", enableUserData)
put("enableTotalRecordCount", enableTotalRecordCount)
}
val data = null
val response = api.`get`("/LiveTv/Programs/Recommended", pathParameters,
queryParameters, data)
return response
}
/**
* Gets recommended live tv epgs.
*
* @param request The request parameters
*/
public suspend fun getRecommendedPrograms(request: GetRecommendedProgramsRequest =
GetRecommendedProgramsRequest()): Response = getRecommendedPrograms(
userId = request.userId,
limit = request.limit,
isAiring = request.isAiring,
hasAired = request.hasAired,
isSeries = request.isSeries,
isMovie = request.isMovie,
isNews = request.isNews,
isKids = request.isKids,
isSports = request.isSports,
enableImages = request.enableImages,
imageTypeLimit = request.imageTypeLimit,
enableImageTypes = request.enableImageTypes,
genreIds = request.genreIds,
fields = request.fields,
enableUserData = request.enableUserData,
enableTotalRecordCount = request.enableTotalRecordCount,
)
/**
* Gets a live tv recording.
*
* @param recordingId Recording id.
* @param userId Optional. Attach user data.
*/
public suspend fun getRecording(recordingId: UUID, userId: UUID? = null): Response {
val pathParameters = buildMap(1) {
put("recordingId", recordingId)
}
val queryParameters = buildMap(1) {
put("userId", userId)
}
val data = null
val response = api.`get`("/LiveTv/Recordings/{recordingId}", pathParameters,
queryParameters, data)
return response
}
/**
* Gets recording folders.
*
* @param userId Optional. Filter by user and attach user data.
*/
public suspend fun getRecordingFolders(userId: UUID? = null): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("userId", userId)
}
val data = null
val response = api.`get`("/LiveTv/Recordings/Folders", pathParameters,
queryParameters, data)
return response
}
/**
* Get recording group.
*
* @param groupId Group id.
*/
@Deprecated("This member is deprecated and may be removed in the future")
public suspend fun getRecordingGroup(groupId: UUID): Response {
val pathParameters = buildMap(1) {
put("groupId", groupId)
}
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/Recordings/Groups/{groupId}", pathParameters,
queryParameters, data)
return response
}
/**
* Gets live tv recording groups.
*
* @param userId Optional. Filter by user and attach user data.
*/
@Deprecated("This member is deprecated and may be removed in the future")
public suspend fun getRecordingGroups(userId: UUID? = null): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(1) {
put("userId", userId)
}
val data = null
val response = api.`get`("/LiveTv/Recordings/Groups", pathParameters,
queryParameters, data)
return response
}
/**
* Gets live tv recordings.
*
* @param channelId Optional. Filter by channel id.
* @param userId Optional. Filter by user and attach user data.
* @param startIndex Optional. The record index to start at. All items with a lower index will be
* dropped from the results.
* @param limit Optional. The maximum number of records to return.
* @param status Optional. Filter by recording status.
* @param isInProgress Optional. Filter by recordings that are in progress, or not.
* @param seriesTimerId Optional. Filter by recordings belonging to a series timer.
* @param enableImages Optional. Include image information in output.
* @param imageTypeLimit Optional. The max number of images to return, per image type.
* @param enableImageTypes Optional. The image types to include in the output.
* @param fields Optional. Specify additional fields of information to return in the output.
* @param enableUserData Optional. Include user data.
* @param isMovie Optional. Filter for movies.
* @param isSeries Optional. Filter for series.
* @param isKids Optional. Filter for kids.
* @param isSports Optional. Filter for sports.
* @param isNews Optional. Filter for news.
* @param isLibraryItem Optional. Filter for is library item.
* @param enableTotalRecordCount Optional. Return total record count.
*/
public 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? = emptyList(),
fields: Collection? = 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 {
val pathParameters = emptyMap()
val queryParameters = buildMap(19) {
put("channelId", channelId)
put("userId", userId)
put("startIndex", startIndex)
put("limit", limit)
put("status", status)
put("isInProgress", isInProgress)
put("seriesTimerId", seriesTimerId)
put("enableImages", enableImages)
put("imageTypeLimit", imageTypeLimit)
put("enableImageTypes", enableImageTypes)
put("fields", fields)
put("enableUserData", enableUserData)
put("isMovie", isMovie)
put("isSeries", isSeries)
put("isKids", isKids)
put("isSports", isSports)
put("isNews", isNews)
put("isLibraryItem", isLibraryItem)
put("enableTotalRecordCount", enableTotalRecordCount)
}
val data = null
val response = api.`get`("/LiveTv/Recordings", pathParameters,
queryParameters, data)
return response
}
/**
* Gets live tv recordings.
*
* @param request The request parameters
*/
public suspend fun getRecordings(request: GetRecordingsRequest = GetRecordingsRequest()):
Response = getRecordings(
channelId = request.channelId,
userId = request.userId,
startIndex = request.startIndex,
limit = request.limit,
status = request.status,
isInProgress = request.isInProgress,
seriesTimerId = request.seriesTimerId,
enableImages = request.enableImages,
imageTypeLimit = request.imageTypeLimit,
enableImageTypes = request.enableImageTypes,
fields = request.fields,
enableUserData = request.enableUserData,
isMovie = request.isMovie,
isSeries = request.isSeries,
isKids = request.isKids,
isSports = request.isSports,
isNews = request.isNews,
isLibraryItem = request.isLibraryItem,
enableTotalRecordCount = request.enableTotalRecordCount,
)
/**
* Gets live tv recording series.
*
* @param channelId Optional. Filter by channel id.
* @param userId Optional. Filter by user and attach user data.
* @param groupId Optional. Filter by recording group.
* @param startIndex Optional. The record index to start at. All items with a lower index will be
* dropped from the results.
* @param limit Optional. The maximum number of records to return.
* @param status Optional. Filter by recording status.
* @param isInProgress Optional. Filter by recordings that are in progress, or not.
* @param seriesTimerId Optional. Filter by recordings belonging to a series timer.
* @param enableImages Optional. Include image information in output.
* @param imageTypeLimit Optional. The max number of images to return, per image type.
* @param enableImageTypes Optional. The image types to include in the output.
* @param fields Optional. Specify additional fields of information to return in the output.
* @param enableUserData Optional. Include user data.
* @param enableTotalRecordCount Optional. Return total record count.
*/
@Deprecated("This member is deprecated and may be removed in the future")
public 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? = emptyList(),
fields: Collection? = emptyList(),
enableUserData: Boolean? = null,
enableTotalRecordCount: Boolean? = true,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(14) {
put("channelId", channelId)
put("userId", userId)
put("groupId", groupId)
put("startIndex", startIndex)
put("limit", limit)
put("status", status)
put("isInProgress", isInProgress)
put("seriesTimerId", seriesTimerId)
put("enableImages", enableImages)
put("imageTypeLimit", imageTypeLimit)
put("enableImageTypes", enableImageTypes)
put("fields", fields)
put("enableUserData", enableUserData)
put("enableTotalRecordCount", enableTotalRecordCount)
}
val data = null
val response = api.`get`("/LiveTv/Recordings/Series", pathParameters,
queryParameters, data)
return response
}
/**
* Gets live tv recording series.
*
* @param request The request parameters
*/
@Deprecated("This member is deprecated and may be removed in the future")
public suspend fun getRecordingsSeries(request: GetRecordingsSeriesRequest =
GetRecordingsSeriesRequest()): Response = getRecordingsSeries(
channelId = request.channelId,
userId = request.userId,
groupId = request.groupId,
startIndex = request.startIndex,
limit = request.limit,
status = request.status,
isInProgress = request.isInProgress,
seriesTimerId = request.seriesTimerId,
enableImages = request.enableImages,
imageTypeLimit = request.imageTypeLimit,
enableImageTypes = request.enableImageTypes,
fields = request.fields,
enableUserData = request.enableUserData,
enableTotalRecordCount = request.enableTotalRecordCount,
)
/**
* Gets available countries.
*/
public suspend fun getSchedulesDirectCountries(): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/ListingProviders/SchedulesDirect/Countries",
pathParameters, queryParameters, data)
return response
}
/**
* Gets available countries.
*/
public fun getSchedulesDirectCountriesUrl(): String {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
return api.createUrl("/LiveTv/ListingProviders/SchedulesDirect/Countries", pathParameters,
queryParameters)
}
/**
* Gets a live tv series timer.
*
* @param timerId Timer id.
*/
public suspend fun getSeriesTimer(timerId: String): Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/SeriesTimers/{timerId}", pathParameters,
queryParameters, data)
return response
}
/**
* Gets live tv series timers.
*
* @param sortBy Optional. Sort by SortName or Priority.
* @param sortOrder Optional. Sort in Ascending or Descending order.
*/
public suspend fun getSeriesTimers(sortBy: String? = null, sortOrder: SortOrder? = null):
Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(2) {
put("sortBy", sortBy)
put("sortOrder", sortOrder)
}
val data = null
val response = api.`get`("/LiveTv/SeriesTimers", pathParameters,
queryParameters, data)
return response
}
/**
* Gets a timer.
*
* @param timerId Timer id.
*/
public suspend fun getTimer(timerId: String): Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val data = null
val response = api.`get`("/LiveTv/Timers/{timerId}", pathParameters,
queryParameters, data)
return response
}
/**
* Gets the live tv timers.
*
* @param channelId Optional. Filter by channel id.
* @param seriesTimerId Optional. Filter by timers belonging to a series timer.
* @param isActive Optional. Filter by timers that are active.
* @param isScheduled Optional. Filter by timers that are scheduled.
*/
public suspend fun getTimers(
channelId: String? = null,
seriesTimerId: String? = null,
isActive: Boolean? = null,
isScheduled: Boolean? = null,
): Response {
val pathParameters = emptyMap()
val queryParameters = buildMap(4) {
put("channelId", channelId)
put("seriesTimerId", seriesTimerId)
put("isActive", isActive)
put("isScheduled", isScheduled)
}
val data = null
val response = api.`get`("/LiveTv/Timers", pathParameters,
queryParameters, data)
return response
}
/**
* Get tuner host types.
*/
public suspend fun getTunerHostTypes(): Response> {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val data = null
val response = api.`get`>("/LiveTv/TunerHosts/Types", pathParameters,
queryParameters, data)
return response
}
/**
* Resets a tv tuner.
*
* @param tunerId Tuner id.
*/
public suspend fun resetTuner(tunerId: String): Response {
val pathParameters = buildMap(1) {
put("tunerId", tunerId)
}
val queryParameters = emptyMap()
val data = null
val response = api.post("/LiveTv/Tuners/{tunerId}/Reset", pathParameters, queryParameters,
data)
return response
}
/**
* Set channel mappings.
*/
public suspend fun setChannelMapping(`data`: SetChannelMappingDto): Response {
val pathParameters = emptyMap()
val queryParameters = emptyMap()
val response = api.post("/LiveTv/ChannelMappings", pathParameters,
queryParameters, data)
return response
}
/**
* Updates a live tv series timer.
*
* @param timerId Timer id.
*/
public suspend fun updateSeriesTimer(timerId: String, `data`: SeriesTimerInfoDto? = null):
Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val response = api.post("/LiveTv/SeriesTimers/{timerId}", pathParameters, queryParameters,
data)
return response
}
/**
* Updates a live tv timer.
*
* @param timerId Timer id.
*/
public suspend fun updateTimer(timerId: String, `data`: TimerInfoDto? = null): Response {
val pathParameters = buildMap(1) {
put("timerId", timerId)
}
val queryParameters = emptyMap()
val response = api.post("/LiveTv/Timers/{timerId}", pathParameters, queryParameters, data)
return response
}
}