Jellyfin SDK Kotlin

https://kotlin-sdk.jellyfin.org/dokka/
Admin
Jellyfin SDK Kotlin is a comprehensive Kotlin client library for interacting with Jellyfin media...
Tokens:589,734
Snippets:5,788
Trust Score:9.9
Update:5 days ago
Show doc for...
Tokens:
Raw
### getPlugins(): Response<List<PluginInfo>>

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/index.html

Gets a list of currently installed plugins.

```APIDOC
## getPlugins

### Description
Gets a list of currently installed plugins.

### Method
suspend fun getPlugins(): Response<List<PluginInfo>>

### Parameters
None.

### Response
Returns `Response<List<PluginInfo>>`.
```

--------------------------------

### installPackage

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/install-package.html

Installs a package by name, optionally specifying assembly GUID, version, and repository URL.

```APIDOC
## installPackage

### Description
Installs a package.

### Method
suspend fun installPackage

### Parameters
- **name** (String) - Required - Package name.
- **assemblyGuid** (UUID?) - Optional - GUID of the associated assembly.
- **version** (String?) - Optional - Optional version. Defaults to latest version.
- **repositoryUrl** (String?) - Optional - Optional. Specify the repository to install from.

### Return Type
Response<Unit>
```

--------------------------------

### getGuideInfo

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-live-tv-api/index.html

Get guide info.

```APIDOC
## getGuideInfo

### Description
Get guide info.

### Method
suspend fun getGuideInfo

### Parameters
None

### Response
- **Response<GuideInfo>** - Guide info
```

--------------------------------

### startTask

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-scheduled-task-api/index.html

Start specified task.

```APIDOC
## startTask

### Description
Start specified task.

### Method
suspend fun startTask(taskId: String): Response<Unit>

### Parameters
- **taskId** (String) - Required - The task id.

### Response
Returns a Response<Unit> indicating success.
```

--------------------------------

### LyricLine(text: String, start: Long? = null, cues: List<LyricLineCue>? = null)

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-lyric-line/-lyric-line.html

Constructs a LyricLine instance with the given text, optional start time, and optional list of cues.

```APIDOC
## LyricLine(text: String, start: Long? = null, cues: List<LyricLineCue>? = null)

### Description
Constructs a LyricLine instance with the given text, optional start time, and optional list of cues.

### Parameters
- **text** (String) - Required - The text of the lyric line.
- **start** (Long?) - Optional - The start time of the lyric line in milliseconds.
- **cues** (List<LyricLineCue>?) - Optional - A list of cues associated with the lyric line.

```

--------------------------------

### InstallationInfo constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-installation-info/-installation-info.html

Creates an InstallationInfo instance with the given parameters. The guid is required, while all other parameters are optional with default values.

```APIDOC
## InstallationInfo

### Description
Data class representing installation information for a plugin or package.

### Constructor
`InstallationInfo(guid: UUID, name: String? = null, version: String? = null, changelog: String? = null, sourceUrl: String? = null, checksum: String? = null, packageInfo: PackageInfo? = null)`

### Parameters
- **guid** (UUID) - Required - The unique identifier for the installation.
- **name** (String?) - Optional - The name of the installed item.
- **version** (String?) - Optional - The version of the installed item.
- **changelog** (String?) - Optional - The changelog for the installed item.
- **sourceUrl** (String?) - Optional - The source URL for the installed item.
- **checksum** (String?) - Optional - The checksum for the installed item.
- **packageInfo** (PackageInfo?) - Optional - Additional package information.
```

--------------------------------

### completeWizard

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-startup-api/index.html

Completes the startup wizard.

```APIDOC
## completeWizard

### Description
Completes the startup wizard.

### Method
suspend fun completeWizard(): Response<Unit>

### Parameters
None

### Response
- **Response<Unit>** - The response indicating success or failure.
```

--------------------------------

### getPackageInfo

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/get-package-info.html

Gets a package by name or assembly GUID.

```APIDOC
## getPackageInfo

### Description
Gets a package by name or assembly GUID.

### Method
suspend fun

### Signature
`getPackageInfo(name: String, assemblyGuid: UUID? = null): Response<PackageInfo>`

### Parameters
- **name** (String) - Required - The name of the package.
- **assemblyGuid** (UUID?) - Optional - The GUID of the associated assembly.

### Response
Returns a `Response<PackageInfo>` containing the package information.
```

--------------------------------

### getSubtitleWithTicksDeprecated

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-subtitle-api/index.html

Gets subtitles in a specified format with start position ticks (deprecated).

```APIDOC
## getSubtitleWithTicksDeprecated

### Description
Gets subtitles in a specified format with start position ticks (deprecated).

### Method
suspend fun getSubtitleWithTicksDeprecated(request: GetSubtitleWithTicksDeprecatedRequest): Response<String>
suspend fun getSubtitleWithTicksDeprecated(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, itemId: UUID? = null, mediaSourceId: String? = null, index: Int? = null, startPositionTicks: Long? = null, format: String? = null, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false): Response<String>

### Parameters
- **request** (GetSubtitleWithTicksDeprecatedRequest) - Required - The request object.
- **routeItemId** (UUID) - Required - The item ID.
- **routeMediaSourceId** (String) - Required - The media source ID.
- **routeIndex** (Int) - Required - The subtitle index.
- **routeStartPositionTicks** (Long) - Required - The start position in ticks.
- **routeFormat** (String) - Required - The subtitle format.
- **itemId** (UUID?) - Optional - The item ID.
- **mediaSourceId** (String?) - Optional - The media source ID.
- **index** (Int?) - Optional - The subtitle index.
- **startPositionTicks** (Long?) - Optional - The start position in ticks.
- **format** (String?) - Optional - The subtitle format.
- **endPositionTicks** (Long?) - Optional - The end position in ticks.
- **copyTimestamps** (Boolean?) - Optional - Whether to copy timestamps.
- **addVttTimeMap** (Boolean?) - Optional - Whether to add VTT time map.

### Response
Returns a Response<String> containing the subtitles.
```

--------------------------------

### installPackage(name: String, assemblyGuid: UUID? = null, version: String? = null, repositoryUrl: String? = null): Response<Unit>

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/index.html

Installs a package.

```APIDOC
## installPackage

### Description
Installs a package.

### Method
suspend fun installPackage(name: String, assemblyGuid: UUID? = null, version: String? = null, repositoryUrl: String? = null): Response<Unit>

### Parameters
- **name** (String) - Required - The package name.
- **assemblyGuid** (UUID?) - Optional - The assembly GUID.
- **version** (String?) - Optional - The package version.
- **repositoryUrl** (String?) - Optional - The repository URL.

### Response
Returns `Response<Unit>`.
```

--------------------------------

### InstallationInfo

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-installation-info/index.html

Data class representing installation information for a Jellyfin plugin or package.

```APIDOC
## InstallationInfo

### Description
Data class representing installation information for a Jellyfin plugin or package.

### Constructor
```kotlin
InstallationInfo(
    guid: UUID,
    name: String? = null,
    version: String? = null,
    changelog: String? = null,
    sourceUrl: String? = null,
    checksum: String? = null,
    packageInfo: PackageInfo? = null
)
```

### Properties
- **guid** (UUID) - The Id.
- **name** (String?) - The name.
- **version** (String?) - The version.
- **changelog** (String?) - The changelog for this version.
- **sourceUrl** (String?) - The source URL.
- **checksum** (String?) - A checksum for the binary.
- **packageInfo** (PackageInfo?) - Package information for the installation.

### Serialization
This class is annotated with `@Serializable` and uses `@SerialName` annotations for JSON serialization:
- `guid` -> "Guid"
- `name` -> "Name"
- `version` -> "Version"
- `changelog` -> "Changelog"
- `sourceUrl` -> "SourceUrl"
- `checksum` -> "Checksum"
- `packageInfo` -> "PackageInfo"

```

--------------------------------

### getStartupConfiguration

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-startup-api/index.html

Gets the initial startup wizard configuration. This method is deprecated.

```APIDOC
## getStartupConfiguration

### Description
Gets the initial startup wizard configuration. This method is deprecated.

### Method
suspend fun getStartupConfiguration(): Response<StartupConfigurationDto>

### Parameters
None

### Response
- **Response<StartupConfigurationDto>** - The startup configuration.
```

--------------------------------

### EncodingOptions(encodingThreadCount, transcodingTempPath, fallbackFontPath, enableFallbackFont, enableAudioVbr, downMixAudioBoost, downMixStereoAlgorithm, maxMuxingQueueSize, enableThrottling, throttleDelaySeconds, enableSegmentDeletion, segmentKeepSeconds, hardwareAccelerationType, encoderAppPath, encoderAppPathDisplay, vaapiDevice, qsvDevice, enableTonemapping, enableVppTonemapping, enableVideoToolboxTonemapping, tonemappingAlgorithm, tonemappingMode, tonemappingRange, tonemappingDesat, tonemappingPeak, tonemappingParam, vppTonemappingBrightness, vppTonemappingContrast, h264Crf, h265Crf, encoderPreset, deinterlaceDoubleRate, deinterlaceMethod, enableDecodingColorDepth10Hevc, enableDecodingColorDepth10Vp9, enableDecodingColorDepth10HevcRext, enableDecodingColorDepth12HevcRext, enableEnhancedNvdecDecoder, preferSystemNativeHwDecoder, enableIntelLowPowerH264HwEncoder, enableIntelLowPowerHevcHwEncoder, enableHardwareEncoding, allowHevcEncoding, allowAv1Encoding, enableSubtitleExtraction, subtitleExtractionTimeoutMinutes, hardwareDecodingCodecs, allowOnDemandMetadataBasedKeyframeExtractionForExtensions, hlsAudioSeekStrategy)

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-encoding-options/-encoding-options.html

Creates an EncodingOptions instance with the specified encoding and transcoding configuration parameters.

```APIDOC
## EncodingOptions(encodingThreadCount, transcodingTempPath, fallbackFontPath, enableFallbackFont, enableAudioVbr, downMixAudioBoost, downMixStereoAlgorithm, maxMuxingQueueSize, enableThrottling, throttleDelaySeconds, enableSegmentDeletion, segmentKeepSeconds, hardwareAccelerationType, encoderAppPath, encoderAppPathDisplay, vaapiDevice, qsvDevice, enableTonemapping, enableVppTonemapping, enableVideoToolboxTonemapping, tonemappingAlgorithm, tonemappingMode, tonemappingRange, tonemappingDesat, tonemappingPeak, tonemappingParam, vppTonemappingBrightness, vppTonemappingContrast, h264Crf, h265Crf, encoderPreset, deinterlaceDoubleRate, deinterlaceMethod, enableDecodingColorDepth10Hevc, enableDecodingColorDepth10Vp9, enableDecodingColorDepth10HevcRext, enableDecodingColorDepth12HevcRext, enableEnhancedNvdecDecoder, preferSystemNativeHwDecoder, enableIntelLowPowerH264HwEncoder, enableIntelLowPowerHevcHwEncoder, enableHardwareEncoding, allowHevcEncoding, allowAv1Encoding, enableSubtitleExtraction, subtitleExtractionTimeoutMinutes, hardwareDecodingCodecs, allowOnDemandMetadataBasedKeyframeExtractionForExtensions, hlsAudioSeekStrategy)

### Description
Creates an EncodingOptions instance with the specified encoding and transcoding configuration parameters.

### Constructor
EncodingOptions(
    encodingThreadCount: Int,
    transcodingTempPath: String? = null,
    fallbackFontPath: String? = null,
    enableFallbackFont: Boolean,
    enableAudioVbr: Boolean,
    downMixAudioBoost: Double,
    downMixStereoAlgorithm: DownMixStereoAlgorithms,
    maxMuxingQueueSize: Int,
    enableThrottling: Boolean,
    throttleDelaySeconds: Int,
    enableSegmentDeletion: Boolean,
    segmentKeepSeconds: Int,
    hardwareAccelerationType: HardwareAccelerationType,
    encoderAppPath: String? = null,
    encoderAppPathDisplay: String? = null,
    vaapiDevice: String? = null,
    qsvDevice: String? = null,
    enableTonemapping: Boolean,
    enableVppTonemapping: Boolean,
    enableVideoToolboxTonemapping: Boolean,
    tonemappingAlgorithm: TonemappingAlgorithm,
    tonemappingMode: TonemappingMode,
    tonemappingRange: TonemappingRange,
    tonemappingDesat: Double,
    tonemappingPeak: Double,
    tonemappingParam: Double,
    vppTonemappingBrightness: Double,
    vppTonemappingContrast: Double,
    h264Crf: Int,
    h265Crf: Int,
    encoderPreset: EncoderPreset,
    deinterlaceDoubleRate: Boolean,
    deinterlaceMethod: DeinterlaceMethod,
    enableDecodingColorDepth10Hevc: Boolean,
    enableDecodingColorDepth10Vp9: Boolean,
    enableDecodingColorDepth10HevcRext: Boolean,
    enableDecodingColorDepth12HevcRext: Boolean,
    enableEnhancedNvdecDecoder: Boolean,
    preferSystemNativeHwDecoder: Boolean,
    enableIntelLowPowerH264HwEncoder: Boolean,
    enableIntelLowPowerHevcHwEncoder: Boolean,
    enableHardwareEncoding: Boolean,
    allowHevcEncoding: Boolean,
    allowAv1Encoding: Boolean,
    enableSubtitleExtraction: Boolean,
    subtitleExtractionTimeoutMinutes: Int,
    hardwareDecodingCodecs: List<String>? = null,
    allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>? = null,
    hlsAudioSeekStrategy: HlsAudioSeekStrategy = HlsAudioSeekStrategy.TRIM_COPIED_AUDIO
)

### Parameters
- **encodingThreadCount** (Int) - Required - Number of threads used for encoding.
- **transcodingTempPath** (String?) - Optional - Path for temporary transcoding files.
- **fallbackFontPath** (String?) - Optional - Path to fallback font.
- **enableFallbackFont** (Boolean) - Required - Whether to enable fallback font.
- **enableAudioVbr** (Boolean) - Required - Whether to enable audio VBR.
- **downMixAudioBoost** (Double) - Required - Audio boost level when downmixing.
- **downMixStereoAlgorithm** (DownMixStereoAlgorithms) - Required - Algorithm used for stereo downmix.
- **maxMuxingQueueSize** (Int) - Required - Maximum muxing queue size.
- **enableThrottling** (Boolean) - Required - Whether to enable throttling.
- **throttleDelaySeconds** (Int) - Required - Delay in seconds for throttling.
- **enableSegmentDeletion** (Boolean) - Required - Whether to enable segment deletion.
- **segmentKeepSeconds** (Int) - Required - Number of seconds to keep segments.
- **hardwareAccelerationType** (HardwareAccelerationType) - Required - Type of hardware acceleration.
- **encoderAppPath** (String?) - Optional - Path to the encoder application.
- **encoderAppPathDisplay** (String?) - Optional - Display path for the encoder application.
- **vaapiDevice** (String?) - Optional - VAAPI device identifier.
- **qsvDevice** (String?) - Optional - QSV device identifier.
- **enableTonemapping** (Boolean) - Required - Whether to enable tonemapping.
- **enableVppTonemapping** (Boolean) - Required - Whether to enable VPP tonemapping.
- **enableVideoToolboxTonemapping** (Boolean) - Required - Whether to enable VideoToolbox tonemapping.
- **tonemappingAlgorithm** (TonemappingAlgorithm) - Required - Tonemapping algorithm.
- **tonemappingMode** (TonemappingMode) - Required - Tonemapping mode.
- **tonemappingRange** (TonemappingRange) - Required - Tonemapping range.
- **tonemappingDesat** (Double) - Required - Tonemapping desaturation level.
- **tonemappingPeak** (Double) - Required - Tonemapping peak.
- **tonemappingParam** (Double) - Required - Tonemapping parameter.
- **vppTonemappingBrightness** (Double) - Required - VPP tonemapping brightness.
- **vppTonemappingContrast** (Double) - Required - VPP tonemapping contrast.
- **h264Crf** (Int) - Required - CRF value for H.264 encoding.
- **h265Crf** (Int) - Required - CRF value for H.265 encoding.
- **encoderPreset** (EncoderPreset) - Required - Encoder preset.
- **deinterlaceDoubleRate** (Boolean) - Required - Whether to enable double rate deinterlacing.
- **deinterlaceMethod** (DeinterlaceMethod) - Required - Deinterlace method.
- **enableDecodingColorDepth10Hevc** (Boolean) - Required - Whether to enable 10-bit HEVC decoding.
- **enableDecodingColorDepth10Vp9** (Boolean) - Required - Whether to enable 10-bit VP9 decoding.
- **enableDecodingColorDepth10HevcRext** (Boolean) - Required - Whether to enable 10-bit HEVC RExt decoding.
- **enableDecodingColorDepth12HevcRext** (Boolean) - Required - Whether to enable 12-bit HEVC RExt decoding.
- **enableEnhancedNvdecDecoder** (Boolean) - Required - Whether to enable enhanced NVDEC decoder.
- **preferSystemNativeHwDecoder** (Boolean) - Required - Whether to prefer system native hardware decoder.
- **enableIntelLowPowerH264HwEncoder** (Boolean) - Required - Whether to enable Intel low power H.264 hardware encoder.
- **enableIntelLowPowerHevcHwEncoder** (Boolean) - Required - Whether to enable Intel low power HEVC hardware encoder.
- **enableHardwareEncoding** (Boolean) - Required - Whether to enable hardware encoding.
- **allowHevcEncoding** (Boolean) - Required - Whether to allow HEVC encoding.
- **allowAv1Encoding** (Boolean) - Required - Whether to allow AV1 encoding.
- **enableSubtitleExtraction** (Boolean) - Required - Whether to enable subtitle extraction.
- **subtitleExtractionTimeoutMinutes** (Int) - Required - Timeout in minutes for subtitle extraction.
- **hardwareDecodingCodecs** (List<String>?) - Optional - List of codecs for hardware decoding.
- **allowOnDemandMetadataBasedKeyframeExtractionForExtensions** (List<String>?) - Optional - List of file extensions for on-demand metadata-based keyframe extraction.
- **hlsAudioSeekStrategy** (HlsAudioSeekStrategy) - Optional - Strategy for HLS audio seeking. Defaults to HlsAudioSeekStrategy.TRIM_COPIED_AUDIO.

### Response
No return value (constructor).
```

--------------------------------

### getPlugins

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/get-plugins.html

Gets a list of currently installed plugins. This is a suspend function that returns a Response containing a list of PluginInfo objects.

```APIDOC
## getPlugins

### Description
Gets a list of currently installed plugins.

### Method
suspend fun getPlugins(): Response<List<PluginInfo>>

### Return Type
Response<List<PluginInfo>>

### Parameters
None

### Response
#### Success Response
- **body** (List<PluginInfo>) - The list of installed plugins.
```

--------------------------------

### getBackup(path: String): Response<BackupManifestDto>

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-backup-api/get-backup.html

Gets the descriptor from an existing archive is present. The path parameter specifies the data to start a restore process.

```APIDOC
## getBackup(path: String): Response<BackupManifestDto>

### Description
Gets the descriptor from an existing archive is present.

### Method
suspend fun

### Parameters
- **path** (String) - Required - The data to start a restore process.

### Response
Returns a Response<BackupManifestDto> containing the backup descriptor.
```

--------------------------------

### suspend fun getStartupConfiguration(): Response<StartupConfigurationDto>

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-startup-api/get-startup-configuration.html

Gets the initial startup wizard configuration. This member is deprecated and may be removed in the future.

```APIDOC
## getStartupConfiguration

### Description
Gets the initial startup wizard configuration. This member is deprecated and may be removed in the future.

### Method
suspend fun getStartupConfiguration(): Response<StartupConfigurationDto>

### Parameters
None

### Response
#### Success Response
- **StartupConfigurationDto** - The initial startup wizard configuration.

### Deprecation
This member is deprecated and may be removed in the future.
```

--------------------------------

### constructor(options: JellyfinOptions)

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk/-jellyfin/-jellyfin.html

Creates a Jellyfin instance with the provided options.

```APIDOC
## constructor(options: JellyfinOptions)

### Description
Creates a Jellyfin instance with the provided options.

### Parameters
- **options** (JellyfinOptions) - Required - The options to configure the Jellyfin client.

### Example
```kotlin
val jellyfin = Jellyfin(options)
```
```

--------------------------------

### cancelPackageInstallation

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-plugin-api/cancel-package-installation.html

Cancels a package installation. Takes a packageId (UUID) as the installation ID.

```APIDOC
## cancelPackageInstallation

### Description
Cancels a package installation.

### Method
suspend fun cancelPackageInstallation(packageId: UUID): Response<Unit>

### Parameters
- **packageId** (UUID) - Required - Installation Id.

### Response
Returns Response<Unit>.
```

--------------------------------

### startTask(taskId: String): Response<Unit>

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-scheduled-task-api/start-task.html

Starts the specified scheduled task. The taskId parameter identifies the task to start.

```APIDOC
## startTask

### Description
Starts the specified scheduled task.

### Method
suspend fun startTask(taskId: String): Response<Unit>

### Parameters
- **taskId** (String) - Required - Task Id.

### Response
Returns a Response<Unit> indicating the result of the operation.
```

--------------------------------

### startRestoreBackup

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-backup-api/index.html

Restores to a backup by restarting the server and applying the backup.

```APIDOC
## startRestoreBackup

### Description
Restores to a backup by restarting the server and applying the backup.

### Method
suspend fun startRestoreBackup(data: BackupRestoreRequestDto): Response<Unit>

### Parameters
- **data** (BackupRestoreRequestDto) - Required - The restore request data.

### Response
Returns a Response<Unit> indicating success or failure.
```

--------------------------------

### get

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.client/-api-client/index.html

Performs an HTTP GET request using the provided path template and parameters. Returns a Response object with the deserialized body.

```APIDOC
## get

### Description
Performs an HTTP GET request using the provided path template and parameters. Returns a Response object with the deserialized body.

### Method
GET

### Signature
```kotlin
inline suspend fun <T : Any> ApiClient.get(
    pathTemplate: String,
    pathParameters: Map<String, Any?> = emptyMap(),
    queryParameters: Map<String, Any?> = emptyMap(),
    requestBody: Any? = null
): Response<T>
```

### Parameters
- **pathTemplate** (String) - Required - The template for the path.
- **pathParameters** (Map<String, Any?>) - Optional - Parameters to fill in the path template.
- **queryParameters** (Map<String, Any?>) - Optional - Query parameters to append to the URL.
- **requestBody** (Any?) - Optional - The request body to send.

### Returns
- **Response<T>** - The response object containing the deserialized body.
```

--------------------------------

### PlaybackStartInfo constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-playback-start-info/-playback-start-info.html

Creates a new PlaybackStartInfo instance with the specified playback state and media information.

```APIDOC
## PlaybackStartInfo constructor

### Description
Creates a new PlaybackStartInfo instance with the specified playback state and media information.

### Method
Constructor

### Parameters
- **canSeek** (Boolean) - Required - Indicates whether the playback can seek.
- **item** (BaseItemDto?) - Optional - The media item being played.
- **itemId** (UUID) - Required - The unique identifier of the item.
- **sessionId** (String?) - Optional - The session identifier.
- **mediaSourceId** (String?) - Optional - The media source identifier.
- **audioStreamIndex** (Int?) - Optional - The audio stream index.
- **subtitleStreamIndex** (Int?) - Optional - The subtitle stream index.
- **isPaused** (Boolean) - Required - Indicates whether playback is paused.
- **isMuted** (Boolean) - Required - Indicates whether playback is muted.
- **positionTicks** (Long?) - Optional - The current playback position in ticks.
- **playbackStartTimeTicks** (Long?) - Optional - The playback start time in ticks.
- **volumeLevel** (Int?) - Optional - The volume level.
- **brightness** (Int?) - Optional - The brightness level.
- **aspectRatio** (String?) - Optional - The aspect ratio.
- **playMethod** (PlayMethod) - Required - The playback method.
- **liveStreamId** (String?) - Optional - The live stream identifier.
- **playSessionId** (String?) - Optional - The playback session identifier.
- **repeatMode** (RepeatMode) - Required - The repeat mode.
- **playbackOrder** (PlaybackOrder) - Required - The playback order.
- **nowPlayingQueue** (List<QueueItem>?) - Optional - The queue of items currently playing.
- **playlistItemId** (String?) - Optional - The playlist item identifier.

### Response
No return value (constructor).
```

--------------------------------

### Get Studios Request - limit parameter

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api.request/-get-studios-request/limit.html

The 'limit' parameter is an optional integer that limits the number of records returned by the Get Studios request.

```APIDOC
## Get Studios Request - limit parameter

### Description
Optional. The maximum number of records to return.

### Parameters
#### Query Parameters
- **limit** (Int?) - Optional - The maximum number of records to return.

```

--------------------------------

### fun build(): CodecProfile

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.deviceprofile/-codec-profile-builder/index.html

Builds and returns a CodecProfile instance.

```APIDOC
## fun build(): CodecProfile

### Description
Builds and returns a CodecProfile instance.

### Method
build

### Returns
- **CodecProfile** - The built CodecProfile.

```

--------------------------------

### ListingsProviderInfo Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-listings-provider-info/-listings-provider-info.html

Creates a new ListingsProviderInfo instance with the specified configuration parameters. All parameters are optional except enableAllTuners, which is required.

```APIDOC
## ListingsProviderInfo Constructor

### Description
Creates a new ListingsProviderInfo instance with the specified configuration parameters. All parameters are optional except enableAllTuners, which is required.

### Method
Constructor

### Parameters
- **id** (String?) - Optional - The identifier.
- **type** (String?) - Optional - The type.
- **username** (String?) - Optional - The username.
- **password** (String?) - Optional - The password.
- **listingsId** (String?) - Optional - The listings identifier.
- **zipCode** (String?) - Optional - The zip code.
- **country** (String?) - Optional - The country.
- **path** (String?) - Optional - The path.
- **enabledTuners** (List<String>?) - Optional - The list of enabled tuners.
- **enableAllTuners** (Boolean) - Required - Whether all tuners are enabled.
- **newsCategories** (List<String>?) - Optional - The list of news categories.
- **sportsCategories** (List<String>?) - Optional - The list of sports categories.
- **kidsCategories** (List<String>?) - Optional - The list of kids categories.
- **movieCategories** (List<String>?) - Optional - The list of movie categories.
- **channelMappings** (List<NameValuePair>?) - Optional - The list of channel mappings.
- **moviePrefix** (String?) - Optional - The movie prefix.
- **preferredLanguage** (String?) - Optional - The preferred language.
- **userAgent** (String?) - Optional - The user agent.

### Example
```kotlin
val provider = ListingsProviderInfo(
    id = "provider1",
    type = "SchedulesDirect",
    username = "user",
    password = "pass",
    listingsId = "listings1",
    zipCode = "12345",
    country = "US",
    path = "/path",
    enabledTuners = listOf("tuner1"),
    enableAllTuners = true,
    newsCategories = listOf("news"),
    sportsCategories = listOf("sports"),
    kidsCategories = listOf("kids"),
    movieCategories = listOf("movies"),
    channelMappings = listOf(NameValuePair("name", "value")),
    moviePrefix = "MOVIE_",
    preferredLanguage = "en",
    userAgent = "MyApp/1.0"
)
```
```

--------------------------------

### VideoType Functions

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-video-type/index.html

The VideoType enum provides functions to get the serial name, retrieve an enum constant by name, and get all enum constants.

```APIDOC
## Functions

### toString
- **Signature**: `open override fun toString(): String`
- **Description**: Returns the serial name of the enum member.

### valueOf
- **Signature**: `fun valueOf(value: String): VideoType`
- **Description**: Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. Extraneous whitespace characters are not permitted.

### values
- **Signature**: `fun values(): Array<VideoType>`
- **Description**: Returns an array containing the constants of this enum type, in the order they're declared.

```

--------------------------------

### getTimer

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-live-tv-api/index.html

Gets a timer.

```APIDOC
## getTimer

### Description
Gets a timer.

### Method
suspend fun

### Signature
```kotlin
suspend fun getTimer(
    timerId: String
): Response<TimerInfoDto>
```

### Parameters
- **timerId** (String) - Required - Timer ID.

### Response
Returns `Response<TimerInfoDto>`.
```

--------------------------------

### constructor OkHttpClient

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api-okhttp/org.jellyfin.sdk.api.okhttp/-ok-http-client/index.html

Creates an OkHttpClient instance with the provided OkHttp client, initial base URL, access token, client info, device info, HTTP client options, and socket connection factory.

```APIDOC
## constructor OkHttpClient

### Description
Creates an OkHttpClient instance with the provided OkHttp client, initial base URL, access token, client info, device info, HTTP client options, and socket connection factory.

### Method
constructor

### Signature
```kotlin
constructor(
    client: OkHttpClient,
    initialBaseUrl: String?,
    initialAccessToken: String?,
    initialClientInfo: ClientInfo,
    initialDeviceInfo: DeviceInfo,
    httpClientOptions: HttpClientOptions,
    socketConnectionFactory: SocketConnectionFactory
)
```

### Parameters
- **client** (OkHttpClient) - Required - The underlying OkHttp client.
- **initialBaseUrl** (String?) - Optional - The initial base URL for API requests.
- **initialAccessToken** (String?) - Optional - The initial access token for authentication.
- **initialClientInfo** (ClientInfo) - Required - Information about the client application.
- **initialDeviceInfo** (DeviceInfo) - Required - Information about the device.
- **httpClientOptions** (HttpClientOptions) - Required - Options for the HTTP client.
- **socketConnectionFactory** (SocketConnectionFactory) - Required - Factory for creating socket connections.
```

--------------------------------

### getTasks

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-scheduled-task-api/index.html

Get tasks.

```APIDOC
## getTasks

### Description
Get tasks.

### Method
suspend fun getTasks(isHidden: Boolean? = null, isEnabled: Boolean? = null): Response<List<TaskInfo>>

### Parameters
- **isHidden** (Boolean?) - Optional - Filter tasks by hidden state.
- **isEnabled** (Boolean?) - Optional - Filter tasks by enabled state.

### Response
Returns a Response<List<TaskInfo>> containing the list of tasks.
```

--------------------------------

### getPlaylist

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-playlist-api/index.html

Get a playlist.

```APIDOC
## getPlaylist

### Description
Get a playlist.

### Method
suspend fun getPlaylist(playlistId: UUID): Response<PlaylistDto>

### Parameters
- **playlistId** (UUID) - Required - The playlist ID.

### Response
Returns a Response<PlaylistDto> containing the playlist details.
```

--------------------------------

### constructor(base: OkHttpClient = okhttp3.OkHttpClient.Builder().build())

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api-okhttp/org.jellyfin.sdk.api.okhttp/-ok-http-factory/index.html

Creates a new OkHttpFactory with an optional base OkHttpClient. All instances will be built on top of the base client.

```APIDOC
## Constructor

### Description
Creates a new OkHttpFactory with an optional base OkHttpClient. All instances will be built on top of the base client.

### Signature
`constructor(base: OkHttpClient = okhttp3.OkHttpClient.Builder().build())`

### Parameters
- **base** (OkHttpClient) - Optional - The base OkHttpClient to use for creating instances. Defaults to a new OkHttpClient built with the default builder.
```

--------------------------------

### constructor(api: ApiClient)

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-studio-api/index.html

Creates a new StudioApi instance with the provided ApiClient.

```APIDOC
## constructor(api: ApiClient)

### Description
Creates a new StudioApi instance.

### Parameters
- **api** (ApiClient) - Required - The API client used for making requests.

```

--------------------------------

### getKeys()

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-authentication-api/index.html

Get all keys.

```APIDOC
## getKeys

### Description
Get all keys.

### Method
GET

### Endpoint
/Auth/Keys

### Parameters
None

### Response
#### Success Response (200)
- **AuthenticationInfoQueryResult** - The query result containing authentication info.

#### Response Example
```json
{
  "items": [],
  "totalRecordCount": 0
}
```
```

--------------------------------

### PublicSystemInfo Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-public-system-info/-public-system-info.html

Creates a new PublicSystemInfo instance with optional parameters for server details.

```APIDOC
## PublicSystemInfo Constructor

### Description
Creates a new PublicSystemInfo instance with optional parameters for server details.

### Method
Constructor

### Parameters
- **localAddress** (String?) - Optional - The local address of the server.
- **serverName** (String?) - Optional - The name of the server.
- **version** (String?) - Optional - The version of the server.
- **productName** (String?) - Optional - The product name of the server.
- **operatingSystem** (String?) - Optional - The operating system of the server.
- **id** (String?) - Optional - The unique identifier of the server.
- **startupWizardCompleted** (Boolean?) - Optional - Indicates whether the startup wizard has been completed.

### Example
```kotlin
val info = PublicSystemInfo(
    localAddress = "http://localhost:8096",
    serverName = "My Server",
    version = "10.8.0",
    productName = "Jellyfin Server",
    operatingSystem = "Linux",
    id = "abc123",
    startupWizardCompleted = true
)
```
```

--------------------------------

### refreshLibrary

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-library-api/index.html

Starts a library scan.

```APIDOC
## refreshLibrary

### Description
Starts a library scan.

### Method
POST

### Endpoint
/Library/Refresh

### Parameters
None

### Response
#### Success Response (200)
- **Unit** - No content.

```

--------------------------------

### getIntros

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-library-api/get-intros.html

Gets intros to play before the main media item plays.

```APIDOC
## getIntros

### Description
Gets intros to play before the main media item plays.

### Method
suspend fun getIntros(itemId: UUID, userId: UUID? = null): Response<BaseItemDtoQueryResult>

### Parameters
- **itemId** (UUID) - Required - Item id.
- **userId** (UUID?) - Optional - User id.

### Returns
Response<BaseItemDtoQueryResult>
```

--------------------------------

### VersionInfo constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-version-info/-version-info.html

Creates a VersionInfo instance with the provided version details. All parameters except version, versionNumber, repositoryName, and repositoryUrl have default values of null.

```APIDOC
## VersionInfo

### Description
Data class representing version information for a Jellyfin SDK component.

### Constructor
`VersionInfo(version: String, versionNumber: String, changelog: String? = null, targetAbi: String? = null, sourceUrl: String? = null, checksum: String? = null, timestamp: String? = null, repositoryName: String, repositoryUrl: String)`

### Parameters
- **version** (String) - Required - The version string.
- **versionNumber** (String) - Required - The version number.
- **changelog** (String?) - Optional - The changelog for this version.
- **targetAbi** (String?) - Optional - The target ABI.
- **sourceUrl** (String?) - Optional - The source URL.
- **checksum** (String?) - Optional - The checksum.
- **timestamp** (String?) - Optional - The timestamp.
- **repositoryName** (String) - Required - The repository name.
- **repositoryUrl** (String) - Required - The repository URL.

### Usage
This constructor is used to create a VersionInfo object. It is typically called by the SDK when retrieving version information.
```

--------------------------------

### GetRecordingsRequest

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api.request/index.html

Request to get recordings.

```APIDOC
## GetRecordingsRequest

### Description
No description provided.

### Properties
- No properties documented.

```

--------------------------------

### GetPersonsRequest

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api.request/index.html

Request to get all persons.

```APIDOC
## GetPersonsRequest

### Description
All persons.

### Properties
- **startIndex** (Int?) - Optional - Start index.
- **limit** (Int?) - Optional - Limit.
- **searchTerm** (String?) - Optional - Search term.
- **nameStartsWith** (String?) - Optional - Name starts with.
- **nameLessThan** (String?) - Optional - Name less than.
- **nameStartsWithOrGreater** (String?) - Optional - Name starts with or greater.
- **fields** (Collection<ItemFields>?) - Optional - Fields.
- **filters** (Collection<ItemFilter>?) - Optional - Filters.
- **isFavorite** (Boolean?) - Optional - Is favorite.
- **enableUserData** (Boolean?) - Optional - Enable user data.
- **imageTypeLimit** (Int?) - Optional - Image type limit.
- **enableImageTypes** (Collection<ImageType>?) - Optional - Enable image types.
- **excludePersonTypes** (Collection<String>?) - Optional - Exclude person types.
- **personTypes** (Collection<String>?) - Optional - Person types.
- **parentId** (UUID?) - Optional - Parent ID.
- **appearsInItemId** (UUID?) - Optional - Appears in item ID.
- **userId** (UUID?) - Optional - User ID.
- **enableImages** (Boolean?) - Optional - Enable images. Default: true.

```

--------------------------------

### getVideoStream

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-video-api/index.html

Gets a video stream.

```APIDOC
## getVideoStream

### Description
Gets a video stream.

### Method
GET

### Endpoint
/Videos/{itemId}/stream

### Parameters
#### Path Parameters
- **itemId** (UUID) - Required - The item ID.

#### Query Parameters
- **container** (String) - Optional - The container type.
- **static** (Boolean) - Optional - Whether to use static streaming.
- **params** (String) - Optional - Additional parameters.
- **tag** (String) - Optional - The tag.
- **playSessionId** (String) - Optional - The play session ID.
- **segmentContainer** (String) - Optional - The segment container.
- **segmentLength** (Int) - Optional - The segment length.
- **minSegments** (Int) - Optional - The minimum number of segments.
- **mediaSourceId** (String) - Optional - The media source ID.
- **deviceId** (String) - Optional - The device ID.
- **audioCodec** (String) - Optional - The audio codec.
- **enableAutoStreamCopy** (Boolean) - Optional - Whether to enable auto stream copy.
- **allowVideoStreamCopy** (Boolean) - Optional - Whether to allow video stream copy.
- **allowAudioStreamCopy** (Boolean) - Optional - Whether to allow audio stream copy.
- **audioSampleRate** (Int) - Optional - The audio sample rate.
- **maxAudioBitDepth** (Int) - Optional - The maximum audio bit depth.
- **audioBitRate** (Int) - Optional - The audio bit rate.
- **audioChannels** (Int) - Optional - The number of audio channels.
- **maxAudioChannels** (Int) - Optional - The maximum number of audio channels.
- **profile** (String) - Optional - The profile.
- **level** (String) - Optional - The level.
- **framerate** (Float) - Optional - The framerate.
- **maxFramerate** (Float) - Optional - The maximum framerate.
- **copyTimestamps** (Boolean) - Optional - Whether to copy timestamps.
- **startTimeTicks** (Long) - Optional - The start time ticks.
- **width** (Int) - Optional - The width.
- **height** (Int) - Optional - The height.
- **maxWidth** (Int) - Optional - The maximum width.
- **maxHeight** (Int) - Optional - The maximum height.
- **videoBitRate** (Int) - Optional - The video bit rate.
- **subtitleStreamIndex** (Int) - Optional - The subtitle stream index.
- **subtitleMethod** (SubtitleDeliveryMethod) - Optional - The subtitle delivery method.
- **maxRefFrames** (Int) - Optional - The maximum reference frames.
- **maxVideoBitDepth** (Int) - Optional - The maximum video bit depth.
- **requireAvc** (Boolean) - Optional - Whether to require AVC.
- **deInterlace** (Boolean) - Optional - Whether to deinterlace.
- **requireNonAnamorphic** (Boolean) - Optional - Whether to require non-anamorphic.
- **transcodingMaxAudioChannels** (Int) - Optional - The maximum audio channels for transcoding.
- **cpuCoreLimit** (Int) - Optional - The CPU core limit.
- **liveStreamId** (String) - Optional - The live stream ID.
- **enableMpegtsM2TsMode** (Boolean) - Optional - Whether to enable MPEG-TS M2TS mode.
- **videoCodec** (String) - Optional - The video codec.
- **subtitleCodec** (String) - Optional - The subtitle codec.
- **transcodeReasons** (String) - Optional - The transcode reasons.
- **audioStreamIndex** (Int) - Optional - The audio stream index.
- **videoStreamIndex** (Int) - Optional - The video stream index.
- **context** (EncodingContext) - Optional - The encoding context.
- **streamOptions** (Map<String, String?>) - Optional - The stream options.
- **enableAudioVbrEncoding** (Boolean) - Optional - Whether to enable audio VBR encoding.

### Response
#### Success Response (200)
- **ByteArray** - The video stream data.

```
Tokens:
Raw