commonMain.org.jellyfin.sdk.api.operations.VideoAttachmentsApi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jellyfin-api Show documentation

Official Kotlin/Java SDK for Jellyfin. org.jellyfin.sdk:jellyfin-api

There is a newer version: 1.6.3

// !!        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.Int
import kotlin.String
import kotlin.collections.emptyMap
import kotlin.collections.mutableMapOf
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.model.UUID

public class VideoAttachmentsApi(
	private val api: ApiClient,
) : Api {
	/**
	 * Get video attachment.
	 *
	 * @param videoId Video ID.
	 * @param mediaSourceId Media Source ID.
	 * @param index Attachment Index.
	 */
	public suspend fun getAttachment(
		videoId: UUID,
		mediaSourceId: String,
		index: Int,
	): Response {
		val pathParameters = mutableMapOf()
		pathParameters["videoId"] = videoId
		pathParameters["mediaSourceId"] = mediaSourceId
		pathParameters["index"] = index
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/Videos/{videoId}/{mediaSourceId}/Attachments/{index}",
				pathParameters, queryParameters, data)
		return response
	}

	/**
	 * Get video attachment.
	 *
	 * @param videoId Video ID.
	 * @param mediaSourceId Media Source ID.
	 * @param index Attachment Index.
	 * @param includeCredentials Add the access token to the url to make an authenticated request.
	 */
	public fun getAttachmentUrl(
		videoId: UUID,
		mediaSourceId: String,
		index: Int,
		includeCredentials: Boolean = false,
	): String {
		val pathParameters = mutableMapOf()
		pathParameters["videoId"] = videoId
		pathParameters["mediaSourceId"] = mediaSourceId
		pathParameters["index"] = index
		val queryParameters = emptyMap()
		return api.createUrl("/Videos/{videoId}/{mediaSourceId}/Attachments/{index}", pathParameters,
				queryParameters, includeCredentials)
	}
}