### startDate Property

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

The start date of the guide.

```kotlin
common
@SerialName(value = "StartDate")
val startDate: DateTime
```

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

### GuideInfo Data Class

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

A serializable data class representing guide information with start and end dates.

```kotlin
common
@Serializable
data class GuideInfo(val startDate: DateTime, val endDate: DateTime)
```

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

### Get Packages

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

Gets a list of available packages.

```kotlin
suspend fun getPackages(): Response<List<PackageInfo>>
```

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

### Get Repositories

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

Gets all available package repositories.

```kotlin
suspend fun getRepositories(): Response<List<RepositoryInfo>>
```

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

### Get Package Info

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

Gets package information by name or assembly GUID.

```kotlin
suspend fun getPackageInfo( name: String,  assemblyGuid: UUID? = null): Response<PackageInfo>
```

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

### Get Configuration Pages

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

Gets the configuration pages, optionally filtering by main menu visibility.

```kotlin
suspend fun getConfigurationPages( enableInMainMenu: Boolean? = null): Response<List<ConfigurationPageInfo>>
```

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

### Get Plugins

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.

```kotlin
suspend fun getPlugins(): Response<List<PluginInfo>>
```

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

### PluginInfo

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

Information about an installed plugin.

```kotlin
@Serializable
data class PluginInfo( val name: String,  val version: String,  val configurationFileName: String? = null,  val description: String,  val id: UUID,  val canUninstall: Boolean,  val hasImage: Boolean,  val status: PluginStatus)
```

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

### PluginInstallationFailedMessage

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

Plugin installation failed message.

```kotlin
common
@Serializable
@SerialName(value = "PackageInstallationFailed")
data class PluginInstallationFailedMessage( val data: InstallationInfo? = null,  val messageId: UUID) : OutboundWebSocketMessage
```

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

### InstallationInfo Constructor

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

The constructor for the InstallationInfo class.

```kotlin
common
constructor( guid: UUID,  name: String? = null,  version: String? = null,  changelog: String? = null,  sourceUrl: String? = null,  checksum: String? = null,  packageInfo: PackageInfo? = null)
```

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

### MissingSystemInfo

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

No system information found from server. Server is returning invalid system info.

```kotlin
common
data class MissingSystemInfo( val throwable: Throwable?) : RecommendedServerIssue
```

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

### Get response content using property delegation

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.client/-response/get-value.html

This example demonstrates how to get the response content using property delegation in Kotlin.

```kotlin
val content by response
```

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

### serverName property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-configuration-dto/index.html

The server name.

```kotlin
common
@SerialName(value = "ServerName")
val serverName: String?
```

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

### GuideInfo Constructor

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

Constructor for the GuideInfo data class.

```kotlin
common
constructor(startDate: DateTime, endDate: DateTime)
```

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

### installPackage Function Signature

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

The suspend function signature for installing a package, including optional parameters for assembly GUID, version, and repository URL.

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

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

### preferredMetadataLanguage property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-configuration-dto/index.html

The preferred language for the metadata.

```kotlin
common
@SerialName(value = "PreferredMetadataLanguage")
val preferredMetadataLanguage: String?
```

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

### uiCulture property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-configuration-dto/index.html

UI language culture.

```kotlin
common
@SerialName(value = "UICulture")
val uiCulture: String?
```

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

### get function signature

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

The signature of the inline suspend function `get` for `ApiClient`.

```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>
```

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

### inactiveSessionThreshold

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-server-configuration/inactive-session-threshold.html

Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled.

```kotlin
common
@SerialName(value = "InactiveSessionThreshold")
val inactiveSessionThreshold: Int
```

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

### MissingVersion

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

No version found in system information.

```kotlin
common
data object MissingVersion : RecommendedServerIssue
```

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

### initiateQuickConnect

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-authentication-api/initiate-quick-connect.html

Initiate a new quick connect request.

```kotlin
suspend fun initiateQuickConnect(): Response<QuickConnectResult>
```

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

### systemInfo Property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-info/index.html

System information about the recommended server.

```kotlin
common
val systemInfo: ERROR CLASS: Symbol not found for Result<ERROR CLASS: Symbol not found for PublicSystemInfo>
```

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

### get Function

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

Performs a GET request to the API.

```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>
```

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

### StartupConfigurationDto

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-configuration-dto/index.html

The startup configuration DTO.

```kotlin
common
@Serializable
data class StartupConfigurationDto(
    val serverName: String? = null,
    val uiCulture: String? = null,
    val metadataCountryCode: String? = null,
    val preferredMetadataLanguage: String? = null
)
```

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

### PluginInstallingMessage

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

Message indicating that a package is currently installing.

```kotlin
@Serializable
@SerialName(value = "PackageInstalling")
data class PluginInstallingMessage( val data: InstallationInfo? = null,  val messageId: UUID) : OutboundWebSocketMessage
```

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

### Cancel Package Installation

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

Cancels a package installation.

```kotlin
suspend fun cancelPackageInstallation( packageId: UUID): Response<Unit>
```

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

### startIndex Property

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

Optional property for the start index of suggestions.

```kotlin
@SerialName(value = "startIndex")
val startIndex: Int?
```

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

### Get Plugin Manifest

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

Gets a plugin's manifest.

```kotlin
suspend fun getPluginManifest(pluginId: UUID): Response<Unit>
```

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

### StartupConfigurationDto constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-configuration-dto/index.html

The startup configuration DTO.

```kotlin
common
constructor(
    serverName: String? = null,
    uiCulture: String? = null,
    metadataCountryCode: String? = null,
    preferredMetadataLanguage: String? = null
)
```

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

### Get Plugin Configuration

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

Gets the configuration for a specific plugin.

```kotlin
suspend fun getPluginConfiguration( pluginId: UUID): Response<BasePluginConfiguration>
```

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

### UnsupportedServerVersion

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

The SDK does not support the server version.

```kotlin
common
data class UnsupportedServerVersion( val version: ERROR CLASS: Symbol not found for ServerVersion) : RecommendedServerIssue
```

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

### Get Attachment URL

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

Gets the URL for a video attachment.

```kotlin
fun getAttachmentUrl( videoId: UUID,  mediaSourceId: String,  index: Int): String
```

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

### Get Plugin Image URL

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

Gets the URL for a plugin's image.

```kotlin
fun getPluginImageUrl(pluginId: UUID, version: String): String
```

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

### Get Plugin Image

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

Gets a plugin's image as a byte array.

```kotlin
suspend fun getPluginImage( pluginId: UUID,  version: String): Response<ByteArray>
```

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

### InstallationInfo Data Class

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

The data class definition for InstallationInfo.

```kotlin
common
@Serializable
data class InstallationInfo( val guid: UUID,  val name: String? = null,  val version: String? = null,  val changelog: String? = null,  val sourceUrl: String? = null,  val checksum: String? = null,  val packageInfo: PackageInfo? = null)
```

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

### Get Dashboard Configuration Page

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

Gets a dashboard configuration page by name.

```kotlin
suspend fun getDashboardConfigurationPage( name: String? = null): Response<String>
```

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

### RecommendedServerInfo Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-info/index.html

The constructor for the RecommendedServerInfo data class.

```kotlin
common
constructor(
    address: String,
    responseTime: Long,
    score: RecommendedServerInfoScore,
    issues: Collection<RecommendedServerIssue>,
    systemInfo: ERROR CLASS: Symbol not found for Result<ERROR CLASS: Symbol not found for PublicSystemInfo>
)
```

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

### ServerConfiguration Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-server-configuration/-server-configuration.html

Parameters for the ServerConfiguration constructor.

```kotlin
constructor( logFileRetentionDays: Int,  isStartupWizardCompleted: Boolean,  cachePath: String? = null,  previousVersion: String? = null,  previousVersionStr: String? = null,  enableMetrics: Boolean,  enableNormalizedItemByNameIds: Boolean,  isPortAuthorized: Boolean,  quickConnectAvailable: Boolean,  enableCaseSensitiveItemIds: Boolean,  disableLiveTvChannelUserDataName: Boolean,  metadataPath: String,  preferredMetadataLanguage: String,  metadataCountryCode: String,  sortReplaceCharacters: List<String>,  sortRemoveCharacters: List<String>,  sortRemoveWords: List<String>,  minResumePct: Int,  maxResumePct: Int,  minResumeDurationSeconds: Int,  minAudiobookResume: Int,  maxAudiobookResume: Int,  inactiveSessionThreshold: Int,  libraryMonitorDelay: Int,  libraryUpdateDuration: Int,  cacheSize: Int,  imageSavingConvention: ImageSavingConvention,  metadataOptions: List<MetadataOptions>,  skipDeserializationForBasicTypes: Boolean,  serverName: String,  uiCulture: String,  saveMetadataHidden: Boolean,  contentTypes: List<NameValuePair>,  remoteClientBitrateLimit: Int,  enableFolderView: Boolean,  enableGroupingMoviesIntoCollections: Boolean,  enableGroupingShowsIntoCollections: Boolean,  displaySpecialsWithinSeasons: Boolean,  codecsUsed: List<String>,  pluginRepositories: List<RepositoryInfo>,  enableExternalContentInSuggestions: Boolean,  imageExtractionTimeoutMs: Int,  pathSubstitutions: List<PathSubstitution>,  enableSlowResponseWarning: Boolean,  slowResponseThresholdMs: Long,  corsHosts: List<String>,  activityLogRetentionDays: Int? = null,  libraryScanFanoutConcurrency: Int,  libraryMetadataRefreshConcurrency: Int,  allowClientLogUpload: Boolean,  dummyChapterDuration: Int,  chapterImageResolution: ImageResolution,  parallelImageEncodingLimit: Int,  castReceiverApplications: List<CastReceiverApplication>,  trickplayOptions: TrickplayOptions,  enableLegacyAuthorization: Boolean)
```

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

### fromString function signature and example

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model/-server-version/-companion/from-string.html

This snippet shows the function signature for fromString and provides an example of its usage.

```kotlin
fun fromString(str: String): ServerVersion?
// Example: 1.0.0, 10.6.4 or 10.7.0.0
```

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

### StartupUserDto

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-user-dto/index.html

Constructor for StartupUserDto.

```kotlin
common
constructor(name: String? = null, password: String? = null)
```

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

### Get Video Stream (Request Object)

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

Gets a video stream using a GetVideoStreamRequest object.

```kotlin
suspend fun getVideoStream( request: GetVideoStreamRequest): Response<ByteArray>
```

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

### PluginInstallingMessage Data Class

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-plugin-installing-message/index.html

Defines the structure for a plugin installation message, including installation data and a message ID.

```kotlin
common
@Serializable
@SerialName(value = "PackageInstalling")
data class PluginInstallingMessage( val data: InstallationInfo? = null,  val messageId: UUID) : OutboundWebSocketMessage
```

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

### LiveTvInfo constructor

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

Constructor for LiveTvInfo.

```kotlin
common
constructor( services: List<LiveTvServiceInfo>,
 isEnabled: Boolean,
 enabledUsers: List<String>)
```

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

### configurationFileName Property

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

The name of the configuration file.

```kotlin
common
@SerialName(value = "ConfigurationFileName")
val configurationFileName: String?
```

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

### Get Video Stream By Container (Detailed Parameters)

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

Gets a video stream by container with a comprehensive set of parameters.

```kotlin
suspend fun getVideoStreamByContainer( itemId: UUID,  container: String,  static: Boolean? = null,  params: String? = null,  tag: String? = null,  deviceProfileId: String? = null,  playSessionId: String? = null,  segmentContainer: String? = null,  segmentLength: Int? = null,  minSegments: Int? = null,  mediaSourceId: String? = null,  deviceId: String? = null,  audioCodec: String? = null,  enableAutoStreamCopy: Boolean? = null,  allowVideoStreamCopy: Boolean? = null,  allowAudioStreamCopy: Boolean? = null,  audioSampleRate: Int? = null,  maxAudioBitDepth: Int? = null,  audioBitRate: Int? = null,  audioChannels: Int? = null,  maxAudioChannels: Int? = null,  profile: String? = null,  level: String? = null,  framerate: Float? = null,  maxFramerate: Float? = null,  copyTimestamps: Boolean? = null,  startTimeTicks: Long? = null,  width: Int? = null,  height: Int? = null,  maxWidth: Int? = null,  maxHeight: Int? = null,  videoBitRate: Int? = null,  subtitleStreamIndex: Int? = null,  subtitleMethod: SubtitleDeliveryMethod? = null,  maxRefFrames: Int? = null,  maxVideoBitDepth: Int? = null,  requireAvc: Boolean? = null,  deInterlace: Boolean? = null,  requireNonAnamorphic: Boolean? = null,  transcodingMaxAudioChannels: Int? = null,  cpuCoreLimit: Int? = null,  liveStreamId: String? = null,  enableMpegtsM2TsMode: Boolean? = null,  videoCodec: String? = null,  subtitleCodec: String? = null,  transcodeReasons: String? = null,  audioStreamIndex: Int? = null,  videoStreamIndex: Int? = null,  context: EncodingContext? = null,  streamOptions: Map<String, String?>? = emptyMap(),  enableAudioVbrEncoding: Boolean? = true): Response<ByteArray>
```

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

### Get Video Stream By Container (Request Object)

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

Gets a video stream by container using a GetVideoStreamByContainerRequest object.

```kotlin
suspend fun getVideoStreamByContainer( request: GetVideoStreamByContainerRequest): Response<ByteArray>
```

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

### SystemInfo

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

Contains information about the Jellyfin server system.

```kotlin
@Serializable
data class SystemInfo( val localAddress: String? = null,  val serverName: String? = null,  val version: String? = null,  val productName: String? = null,  val operatingSystem: String? = null,  val id: String? = null,  val startupWizardCompleted: Boolean? = null,  val operatingSystemDisplayName: String? = null,  val packageName: String? = null,  val hasPendingRestart: Boolean,  val isShuttingDown: Boolean,  val supportsLibraryMonitor: Boolean,  val webSocketPortNumber: Int,  val completedInstallations: List<InstallationInfo>? = null,  val canSelfRestart: Boolean = true,  val canLaunchWebBrowser: Boolean = false,  val programDataPath: String? = null,  val webPath: String? = null,  val itemsByNamePath: String? = null,  val cachePath: String? = null,  val logPath: String? = null,  val internalMetadataPath: String? = null,  val transcodingTempPath: String? = null,  val castReceiverApplications: List<CastReceiverApplication>? = null,  val hasUpdateAvailable: Boolean = false,  val encoderLocation: String? = "System",  val systemArchitecture: String? = "X64")
Class SystemInfo.
```

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

### AllThemeMediaResult Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-all-theme-media-result/-all-theme-media-result.html

Constructor for AllThemeMediaResult with optional theme videos, theme songs, and soundtrack songs.

```kotlin
constructor( themeVideosResult: ThemeMediaResult? = null,  themeSongsResult: ThemeMediaResult? = null,  soundtrackSongsResult: ThemeMediaResult? = null)
```

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

### Get Users Function Signature

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

The suspend function signature for retrieving users, including optional filter parameters.

```kotlin
suspend fun getUsers( isHidden: Boolean? = null,  isDisabled: Boolean? = null): Response<List<UserDto>>
```

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

### getPlaylist

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

Gets a playlist.

```kotlin
suspend fun getPlaylist(playlistId: UUID): Response<PlaylistDto>
```

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

### VersionInfo

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

Constructor for VersionInfo.

```kotlin
common
constructor( version: String,  versionNumber: String,  changelog: String? = null,  targetAbi: String? = null,  sourceUrl: String? = null,  checksum: String? = null,  timestamp: String? = null,  repositoryName: String,  repositoryUrl: String)
```

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

### getInstantMixFromItem

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

Creates an instant playlist based on a given item.

```kotlin
suspend fun getInstantMixFromItem( request: GetInstantMixFromItemRequest): Response<BaseItemDtoQueryResult>
```

```kotlin
suspend fun getInstantMixFromItem( itemId: UUID,  userId: UUID? = null,  limit: Int? = null,  fields: Collection<ItemFields>? = emptyList(),  enableImages: Boolean? = null,  enableUserData: Boolean? = null,  imageTypeLimit: Int? = null,  enableImageTypes: Collection<ImageType>? = emptyList()): Response<BaseItemDtoQueryResult>
```

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

### getSessions

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

Gets a list of sessions.

```kotlin
suspend fun getSessions( controllableByUserId: UUID? = null,  deviceId: String? = null,  activeWithinSeconds: Int? = null): Response<List<SessionInfoDto>>
```

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

### getPlaylistUser

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

Get a playlist user.

```kotlin
suspend fun getPlaylistUser( playlistId: UUID,
  userId: UUID): Response<PlaylistUserPermissions>
```

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

### getSchedulesDirectCountries

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-live-tv-api/get-schedules-direct-countries.html

Gets available countries.

```kotlin
suspend fun getSchedulesDirectCountries(): Response<ByteArray>
```

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

### BackupManifestDto constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-backup-manifest-dto/index.html

Constructor for BackupManifestDto.

```kotlin
common
constructor( serverVersion: String,  backupEngineVersion: String,  dateCreated: DateTime,  path: String,  options: BackupOptionsDto)
```

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

### PlaybackStartInfo Data Class

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

Represents information when playback starts.

```kotlin
@Serializable
data class PlaybackStartInfo(
 val canSeek: Boolean,
 val item: BaseItemDto? = null,
 val itemId: UUID,
 val sessionId: String? = null,
 val mediaSourceId: String? = null,
 val audioStreamIndex: Int? = null,
 val subtitleStreamIndex: Int? = null,
 val isPaused: Boolean,
 val isMuted: Boolean,
 val positionTicks: Long? = null,
 val playbackStartTimeTicks: Long? = null,
 val volumeLevel: Int? = null,
 val brightness: Int? = null,
 val aspectRatio: String? = null,
 val playMethod: PlayMethod,
 val liveStreamId: String? = null,
 val playSessionId: String? = null,
 val repeatMode: RepeatMode,
 val playbackOrder: PlaybackOrder,
 val nowPlayingQueue: List<QueueItem>? = null,
 val playlistItemId: String? = null
)
```

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

### getThemeVideos with parameters

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

Get theme videos for an item with explicit parameters.

```kotlin
suspend fun getThemeVideos( itemId: UUID,  userId: UUID? = null,  inheritFromParent: Boolean? = false,  sortBy: Collection<ItemSortBy>? = emptyList(),  sortOrder: Collection<SortOrder>? = emptyList()): Response<ThemeMediaResult>
```

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

### getArtistByName

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

Gets an artist by their name.

```kotlin
suspend fun getArtistByName( name: String, userId: UUID? = null): Response<BaseItemDto>
```

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

### GetTrailersRequest

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

Request to get trailers.

```kotlin
@Serializable
data class GetTrailersRequest( val userId: UUID? = null,  val maxOfficialRating: String? = null,  val hasThemeSong: Boolean? = null,  val hasThemeVideo: Boolean? = null,  val hasSubtitles: Boolean? = null,  val hasSpecialFeature: Boolean? = null,  val hasTrailer: Boolean? = null,  val adjacentTo: UUID? = null,  val parentIndexNumber: Int? = null,  val hasParentalRating: Boolean? = null,  val isHd: Boolean? = null,  val is4k: Boolean? = null,  val locationTypes: Collection<LocationType>? = null,  val excludeLocationTypes: Collection<LocationType>? = null,  val isMissing: Boolean? = null,  val isUnaired: Boolean? = null,  val minCommunityRating: Double? = null,  val minCriticRating: Double? = null,  val minPremiereDate: DateTime? = null,  val minDateLastSaved: DateTime? = null,  val minDateLastSavedForUser: DateTime? = null,  val maxPremiereDate: DateTime? = null,  val hasOverview: Boolean? = null,  val hasImdbId: Boolean? = null,  val hasTmdbId: Boolean? = null,  val hasTvdbId: Boolean? = null,  val isMovie: Boolean? = null,  val isSeries: Boolean? = null,  val isNews: Boolean? = null,  val isKids: Boolean? = null,  val isSports: Boolean? = null,  val excludeItemIds: Collection<UUID>? = null,  val startIndex: Int? = null,  val limit: Int? = null,  val recursive: Boolean? = null,  val searchTerm: String? = null,  val sortOrder: Collection<SortOrder>? = null,  val parentId: UUID? = null,  val fields: Collection<ItemFields>? = null,  val excludeItemTypes: Collection<BaseItemKind>? = null,  val filters: Collection<ItemFilter>? = null,  val isFavorite: Boolean? = null,  val mediaTypes: Collection<MediaType>? = null,  val imageTypes: Collection<ImageType>? = null,  val sortBy: Collection<ItemSortBy>? = null,  val isPlayed: Boolean? = null,  val genres: Collection<String>? = null,  val officialRatings: Collection<String>? = null,  val tags: Collection<String>? = null,  val years: Collection<Int>? = null,  val enableUserData: Boolean? = null,  val imageTypeLimit: Int? = null,  val enableImageTypes: Collection<ImageType>? = null,  val person: String? = null,  val personIds: Collection<UUID>? = null,  val personTypes: Collection<String>? = null,  val studios: Collection<String>? = null,  val artists: Collection<String>? = null,  val excludeArtistIds: Collection<UUID>? = null,  val artistIds: Collection<UUID>? = null,  val albumArtistIds: Collection<UUID>? = null,  val contributingArtistIds: Collection<UUID>? = null,  val albums: Collection<String>? = null,  val albumIds: Collection<UUID>? = null,  val ids: Collection<UUID>? = null,  val videoTypes: Collection<VideoType>? = null,  val minOfficialRating: String? = null,  val isLocked: Boolean? = null,  val isPlaceHolder: Boolean? = null,  val hasOfficialRating: Boolean? =)
```

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

### PlaybackStartInfo Constructor

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

Constructor for the PlaybackStartInfo data class, detailing all parameters required to initialize playback start information.

```kotlin
constructor(
 canSeek: Boolean,
 item: BaseItemDto? = null,
 itemId: UUID,
 sessionId: String? = null,
 mediaSourceId: String? = null,
 audioStreamIndex: Int? = null,
 subtitleStreamIndex: Int? = null,
 isPaused: Boolean,
 isMuted: Boolean,
 positionTicks: Long? = null,
 playbackStartTimeTicks: Long? = null,
 volumeLevel: Int? = null,
 brightness: Int? = null,
 aspectRatio: String? = null,
 playMethod: PlayMethod,
 liveStreamId: String? = null,
 playSessionId: String? = null,
 repeatMode: RepeatMode,
 playbackOrder: PlaybackOrder,
 nowPlayingQueue: List<QueueItem>? = null,
 playlistItemId: String? = null
)
```

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

### getUserViews Function

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

Get user views.

```kotlin
suspend fun getUserViews( userId: UUID? = null,  includeExternalContent: Boolean? = null,  presetViews: Collection<CollectionType>? = emptyList(),  includeHidden: Boolean? = false): Response<BaseItemDtoQueryResult>
```

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

### InvalidProductName

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

The product name in the system information is incorrect.

```kotlin
common
data class InvalidProductName( val productName: String?) : RecommendedServerIssue
```

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

### syncPlayGetGroup

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

Gets a SyncPlay group by id.

```kotlin
suspend fun syncPlayGetGroup(id: UUID): Response<GroupInfoDto>
```

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

### SecureConnectionFailed

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

Failed to acquire a secure connection. This happens due to incorrect SSL configurations.

```kotlin
common
data class SecureConnectionFailed( val sslException: ERROR CLASS: Symbol not found for SecureConnectionException) : RecommendedServerIssue
```

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

### getTrickplayTileImage

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-trick-play-api/get-trickplay-tile-image.html

Gets a trickplay tile image.

```kotlin
suspend fun getTrickplayTileImage( itemId: UUID,  width: Int,  index: Int,  mediaSourceId: UUID? = null): Response<ByteArray>
```

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

### GetInstantMixFromSongRequest

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

Creates an instant playlist based on a given song.

```kotlin
data class GetInstantMixFromSongRequest( val itemId: UUID,  val userId: UUID? = null,  val limit: Int? = null,  val fields: Collection<ItemFields>? = null,  val enableImages: Boolean? = null,  val enableUserData: Boolean? = null,  val imageTypeLimit: Int? = null,  val enableImageTypes: Collection<ImageType>? = null)
```

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

### MediaPathInfo Constructor

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

Constructor for MediaPathInfo.

```kotlin
common
constructor(path: String)
```

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

### getTrickplayTileImageUrl

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-trick-play-api/get-trickplay-tile-image-url.html

Gets a trickplay tile image.

```kotlin
fun getTrickplayTileImageUrl( itemId: UUID,  width: Int,  index: Int,  mediaSourceId: UUID? = null): String
```

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

### getPlaylistUsers

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

Get a playlist's users.

```kotlin
suspend fun getPlaylistUsers( playlistId: UUID): Response<List<PlaylistUserPermissions>>
```

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

### getInstantMixFromPlaylist

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

Creates an instant playlist based on a given playlist.

```kotlin
suspend fun getInstantMixFromPlaylist( request: GetInstantMixFromPlaylistRequest): Response<BaseItemDtoQueryResult>
```

```kotlin
suspend fun getInstantMixFromPlaylist( itemId: UUID,  userId: UUID? = null,  limit: Int? = null,  fields: Collection<ItemFields>? = emptyList(),  enableImages: Boolean? = null,  enableUserData: Boolean? = null,  imageTypeLimit: Int? = null,  enableImageTypes: Collection<ImageType>? = emptyList()): Response<BaseItemDtoQueryResult>
```

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

### ConfigurationPageInfo

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

Constructor for ConfigurationPageInfo.

```kotlin
common
constructor(
    name: String,
    enableInMainMenu: Boolean,
    menuSection: String? = null,
    menuIcon: String? = null,
    displayName: String? = null,
    pluginId: UUID? = null
)
```

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

### getPlaylistUsers

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

Get a playlist's users.

```kotlin
suspend fun getPlaylistUsers(playlistId: UUID): Response<List<PlaylistUserPermissions>>
```

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

### Constructor

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

Initializes the DisplayPreferenceApi with an ApiClient.

```kotlin
DisplayPreferenceApi(api: ApiClient)
```

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

### getSpecialFeatures

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

Gets special features for an item.

```kotlin
suspend fun getSpecialFeatures( itemId: UUID,  userId: UUID? = null): Response<List<BaseItemDto>>
```

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

### PlaybackStopInfo Constructor

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

The constructor for the PlaybackStopInfo class.

```kotlin
constructor(
  item: BaseItemDto? = null,
  itemId: UUID,
  sessionId: String? = null,
  mediaSourceId: String? = null,
  positionTicks: Long? = null,
  liveStreamId: String? = null,
  playSessionId: String? = null,
  failed: Boolean,
  nextMediaType: String? = null,
  playlistItemId: String? = null,
  nowPlayingQueue: List<QueueItem>? = null
)
```

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

### getLibraryOptionsInfo

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

Gets the library options info.

```kotlin
suspend fun getLibraryOptionsInfo( libraryContentType: CollectionType? = null,  isNewLibrary: Boolean? = false): Response<LibraryOptionsResultDto>
```

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

### getInstantMixFromSong

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

Creates an instant playlist based on a given song.

```kotlin
suspend fun getInstantMixFromSong( request: GetInstantMixFromSongRequest): Response<BaseItemDtoQueryResult>
```

```kotlin
suspend fun getInstantMixFromSong( itemId: UUID,  userId: UUID? = null,  limit: Int? = null,  fields: Collection<ItemFields>? = emptyList(),  enableImages: Boolean? = null,  enableUserData: Boolean? = null,  imageTypeLimit: Int? = null,  enableImageTypes: Collection<ImageType>? = emptyList()): Response<BaseItemDtoQueryResult>
```

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

### getSplashscreenUrl signature

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-image-api/get-splashscreen-url.html

Generates or gets the splashscreen.

```kotlin
fun getSplashscreenUrl(tag: String? = null, format: ImageFormat? = null): String
```

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

### QuickConnectDto

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

Request body for the Quick Connect authentication process.

```kotlin
@Serializable
data class QuickConnectDto(val secret: String)
```

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

### getGenreImageUrl

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-image-api/get-genre-image-url.html

Get genre image by name.

```kotlin
fun getGenreImageUrl( name: String,  imageType: ImageType,  tag: String? = null,  format: ImageFormat? = null,  maxWidth: Int? = null,  maxHeight: Int? = null,  percentPlayed: Double? = null,  unplayedCount: Int? = null,  width: Int? = null,  height: Int? = null,  quality: Int? = null,  fillWidth: Int? = null,  fillHeight: Int? = null,  blur: Int? = null,  backgroundColor: String? = null,  foregroundLayer: String? = null,  imageIndex: Int? = null): String
```

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

### menuSection

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

The menu section.

```kotlin
common
@SerialName(value = "MenuSection")
val menuSection: String?
```

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

### VirtualFolderInfo

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

Constructor for VirtualFolderInfo.

```kotlin
common
@Serializable
data class VirtualFolderInfo( val name: String? = null,  val locations: List<String>? = null,  val collectionType: CollectionTypeOptions? = null,  val libraryOptions: LibraryOptions? = null,  val itemId: String? = null,  val primaryImageItemId: String? = null,  val refreshProgress: Double? = null,  val refreshStatus: String? = null)
```

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

### PluginInstallationCancelledMessage

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

Plugin installation cancelled message.

```kotlin
common
@Serializable
@SerialName(value = "PackageInstallationCancelled")
data class PluginInstallationCancelledMessage( val data: InstallationInfo? = null,  val messageId: UUID) : OutboundWebSocketMessage
```

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

### VirtualFolderInfo

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

Constructor for VirtualFolderInfo.

```kotlin
common
constructor( name: String? = null,  locations: List<String>? = null,  collectionType: CollectionTypeOptions? = null,  libraryOptions: LibraryOptions? = null,  itemId: String? = null,  primaryImageItemId: String? = null,  refreshProgress: Double? = null,  refreshStatus: String? = null)
```

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

### capabilities

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

The capabilities.

```kotlin
common
@SerialName(value = "Capabilities")
val capabilities: ClientCapabilitiesDto
```

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

### endDate Property

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

The end date of the guide.

```kotlin
common
@SerialName(value = "EndDate")
val endDate: DateTime
```

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

### GetYearsRequest

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

Represents a request to get years.

```kotlin
@Serializable
data class GetYearsRequest( val startIndex: Int? = null,  val limit: Int? = null,  val sortOrder: Collection<SortOrder>? = null,  val parentId: UUID? = null,  val fields: Collection<ItemFields>? = null,  val excludeItemTypes: Collection<BaseItemKind>? = null,  val includeItemTypes: Collection<BaseItemKind>? = null,  val mediaTypes: Collection<MediaType>? = null,  val sortBy: Collection<ItemSortBy>? = null,  val enableUserData: Boolean? = null,  val imageTypeLimit: Int? = null,  val enableImageTypes: Collection<ImageType>? = null,  val userId: UUID? = null,  val recursive: Boolean? = true,  val enableImages: Boolean? = true)
```

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

### GetEpisodesRequest

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

Represents a request to get episodes.

```kotlin
@Serializable
data class GetEpisodesRequest( val seriesId: UUID,  val userId: UUID? = null,  val fields: Collection<ItemFields>? = null,  val season: Int? = null,  val seasonId: UUID? = null,  val isMissing: Boolean? = null,  val adjacentTo: UUID? = null,  val startItemId: UUID? = null,  val startIndex: Int? = null,  val limit: Int? = null,  val enableImages: Boolean? = null,  val imageTypeLimit: Int? = null,  val enableImageTypes: Collection<ImageType>? = null,  val enableUserData: Boolean? = null,  val sortBy: ItemSortBy? = null)
```

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

### STARTUP_TRIGGER

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

STARTUP_TRIGGER

```kotlin
@SerialName(value = "StartupTrigger")
STARTUP_TRIGGER
```

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

### GetMusicGenreImageRequest

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

Get music genre image by name.

```kotlin
common
@Serializable
data class GetMusicGenreImageRequest( val name: String,  val imageType: ImageType,  val tag: String? = null,  val format: ImageFormat? = null,  val maxWidth: Int? = null,  val maxHeight: Int? = null,  val percentPlayed: Double? = null,  val unplayedCount: Int? = null,  val width: Int? = null,  val height: Int? = null,  val quality: Int? = null,  val fillWidth: Int? = null,  val fillHeight: Int? = null,  val blur: Int? = null,  val backgroundColor: String? = null,  val foregroundLayer: String? = null,  val imageIndex: Int? = null)
```

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

### GetInstantMixFromItemRequest Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api.request/-get-instant-mix-from-item-request/index.html

Creates an instant playlist based on a given item.

```kotlin
common
@Serializable
data class GetInstantMixFromItemRequest(
    val itemId: UUID,
    val userId: UUID? = null,
    val limit: Int? = null,
    val fields: Collection<ItemFields>? = null,
    val enableImages: Boolean? = null,
    val enableUserData: Boolean? = null,
    val imageTypeLimit: Int? = null,
    val enableImageTypes: Collection<ImageType>? = null
)
```

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

### GetInstantMixFromItemRequest Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api.request/-get-instant-mix-from-item-request/index.html

Creates an instant playlist based on a given item.

```kotlin
common
constructor(
    itemId: UUID,
    userId: UUID? = null,
    limit: Int? = null,
    fields: Collection<ItemFields>? = null,
    enableImages: Boolean? = null,
    enableUserData: Boolean? = null,
    imageTypeLimit: Int? = null,
    enableImageTypes: Collection<ImageType>? = null
)
```

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

### Entries Property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-process-priority-class/index.html

Property to get all enum entries.

```kotlin
common
val entries: EnumEntries<ProcessPriorityClass>
```

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

### Entries Property

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

Property to get all enum entries.

```kotlin
val entries: EnumEntries<LiveTvServiceStatus>
```

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

### path property

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-backup-manifest-dto/index.html

The path to the backup on the system.

```kotlin
common
@SerialName(value = "Path")
val path: String
```

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

### values Function

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-info-score/index.html

Function to get all enum constants.

```kotlin
fun values(): Array<RecommendedServerInfoScore>
```

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

### completeWizard Function

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

Completes the startup wizard.

```kotlin
suspend fun completeWizard(): Response<Unit>
```

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

### getInstantMixFromAlbum

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

Creates an instant playlist based on a given album.

```kotlin
suspend fun getInstantMixFromAlbum( request: GetInstantMixFromAlbumRequest): Response<BaseItemDtoQueryResult>
```

```kotlin
suspend fun getInstantMixFromAlbum( itemId: UUID,  userId: UUID? = null,  limit: Int? = null,  fields: Collection<ItemFields>? = emptyList(),  enableImages: Boolean? = null,  enableUserData: Boolean? = null,  imageTypeLimit: Int? = null,  enableImageTypes: Collection<ImageType>? = emptyList()): Response<BaseItemDtoQueryResult>
```

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

### getVideoStreamUrl

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

Gets a video stream.

```kotlin
fun getVideoStreamUrl(
    itemId: UUID,
    container: String? = null,
    static: Boolean? = null,
    params: String? = null,
    tag: String? = null,
    playSessionId: String? = null,
    segmentContainer: String? = null,
    segmentLength: Int? = null,
    minSegments: Int? = null,
    mediaSourceId: String? = null,
    deviceId: String? = null,
    audioCodec: String? = null,
    enableAutoStreamCopy: Boolean? = null,
    allowVideoStreamCopy: Boolean? = null,
    allowAudioStreamCopy: Boolean? = null,
    audioSampleRate: Int? = null,
    maxAudioBitDepth: Int? = null,
    audioBitRate: Int? = null,
    audioChannels: Int? = null,
    maxAudioChannels: Int? = null,
    profile: String? = null,
    level: String? = null,
    framerate: Float? = null,
    maxFramerate: Float? = null,
    copyTimestamps: Boolean? = null,
    startTimeTicks: Long? = null,
    width: Int? = null,
    height: Int? = null,
    maxWidth: Int? = null,
    maxHeight: Int? = null,
    videoBitRate: Int? = null,
    subtitleStreamIndex: Int? = null,
    subtitleMethod: SubtitleDeliveryMethod? = null,
    maxRefFrames: Int? = null,
    maxVideoBitDepth: Int? = null,
    requireAvc: Boolean? = null,
    deInterlace: Boolean? = null,
    requireNonAnamorphic: Boolean? = null,
    transcodingMaxAudioChannels: Int? = null,
    cpuCoreLimit: Int? = null,
    liveStreamId: String? = null,
    enableMpegtsM2TsMode: Boolean? = null,
    videoCodec: String? = null,
    subtitleCodec: String? = null,
    transcodeReasons: String? = null,
    audioStreamIndex: Int? = null,
    videoStreamIndex: Int? = null,
    context: EncodingContext? = null,
    streamOptions: Map<String, String?>? = emptyMap(),
    enableAudioVbrEncoding: Boolean? = true
): String
```

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

### ConfigurationPageInfo Constructor

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

Constructor for ConfigurationPageInfo.

```kotlin
constructor( name: String,  enableInMainMenu: Boolean,  menuSection: String? = null,  menuIcon: String? = null,  displayName: String? = null,  pluginId: UUID? = null)
```

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

### getTrickplayHlsPlaylist

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-trick-play-api/get-trickplay-hls-playlist.html

Gets an image tiles playlist for trickplay.

```kotlin
suspend fun getTrickplayHlsPlaylist( itemId: UUID,  width: Int,  mediaSourceId: UUID? = null): Response<ByteArray>
```

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

### SlowResponse

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-core/org.jellyfin.sdk.discovery/-recommended-server-issue/index.html

The system information response was slow.

```kotlin
common
data class SlowResponse( val responseTime: Long) : RecommendedServerIssue
```

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

### getSubtitlePlaylistUrl

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-subtitle-api/get-subtitle-playlist-url.html

Gets an HLS subtitle playlist.

```kotlin
fun getSubtitlePlaylistUrl( itemId: UUID,  index: Int,  mediaSourceId: String,  segmentLength: Int): String
```

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

### getPlaylistUser

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

Get a playlist user's permissions.

```kotlin
suspend fun getPlaylistUser( playlistId: UUID,  userId: UUID): Response<PlaylistUserPermissions>
```

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

### AllThemeMediaResult Constructor

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-all-theme-media-result/index.html

Constructor for the AllThemeMediaResult class, allowing initialization of its properties.

```kotlin
common
constructor( themeVideosResult: ThemeMediaResult? = null,  themeSongsResult: ThemeMediaResult? = null,  soundtrackSongsResult: ThemeMediaResult? = null)
```

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

### getLiveRecordingFileUrl

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-live-tv-api/get-live-recording-file-url.html

Gets a live tv recording stream.

```kotlin
fun getLiveRecordingFileUrl(recordingId: String): String
```

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

### PlayRequest

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

Opens a media source. Instructs a session to play an item.

```kotlin
common
@Serializable
data class PlayRequest(
    val sessionId: String,
    val playCommand: PlayCommand,
    val itemIds: Collection<UUID>,
    val startPositionTicks: Long? = null,
    val mediaSourceId: String? = null,
    val audioStreamIndex: Int? = null,
    val subtitleStreamIndex: Int? = null,
    val startIndex: Int? = null
)
```

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

### getFileUrl

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

Get the original file of an item.

```kotlin
fun getFileUrl(itemId: UUID): String
```

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

### Set Repositories

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

Sets the enabled and existing package repositories.

```kotlin
suspend fun setRepositories( data: List<RepositoryInfo>): Response<Unit>
```

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

### StartupUserDto

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-model/org.jellyfin.sdk.model.api/-startup-user-dto/index.html

The startup user DTO.

```kotlin
common
@Serializable
data class StartupUserDto(val name: String? = null, val password: String? = null)
```

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

### getMusicAlbumRemoteSearchResults

Source: https://kotlin-sdk.jellyfin.org/dokka/jellyfin-api/org.jellyfin.sdk.api.operations/-item-lookup-api/get-music-album-remote-search-results.html

Get music album remote search.

```kotlin
suspend fun getMusicAlbumRemoteSearchResults( data: AlbumInfoRemoteSearchQuery): Response<List<RemoteSearchResult>>
```

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

### getAudioStreamDeprecatedUrl

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

Gets an audio stream.

```kotlin
fun ~~getAudioStreamDeprecatedUrl~~(
    itemId: UUID,
    container: String? = null,
    static: Boolean? = null,
    params: String? = null,
    tag: String? = null,
    deviceProfileId: String? = null,
    playSessionId: String? = null,
    segmentContainer: String? = null,
    segmentLength: Int? = null,
    minSegments: Int? = null,
    mediaSourceId: String? = null,
    deviceId: String? = null,
    audioCodec: String? = null,
    enableAutoStreamCopy: Boolean? = null,
    allowVideoStreamCopy: Boolean? = null,
    allowAudioStreamCopy: Boolean? = null,
    audioSampleRate: Int? = null,
    maxAudioBitDepth: Int? = null,
    audioBitRate: Int? = null,
    audioChannels: Int? = null,
    maxAudioChannels: Int? = null,
    profile: String? = null,
    level: String? = null,
    framerate: Float? = null,
    maxFramerate: Float? = null,
    copyTimestamps: Boolean? = null,
    startTimeTicks: Long? = null,
    width: Int? = null,
    height: Int? = null,
    videoBitRate: Int? = null,
    subtitleStreamIndex: Int? = null,
    subtitleMethod: SubtitleDeliveryMethod? = null,
    maxRefFrames: Int? = null,
    maxVideoBitDepth: Int? = null,
    requireAvc: Boolean? = null,
    deInterlace: Boolean? = null,
    requireNonAnamorphic: Boolean? = null,
    transcodingMaxAudioChannels: Int? = null,
    cpuCoreLimit: Int? = null,
    liveStreamId: String? = null,
    enableMpegtsM2TsMode: Boolean? = null,
    videoCodec: String? = null,
    subtitleCodec: String? = null,
    transcodeReasons: String? = null,
    audioStreamIndex: Int? = null,
    videoStreamIndex: Int? = null,
    context: EncodingContext? = null,
    streamOptions: Map<String, String?>? = emptyMap(),
    enableAudioVbrEncoding: Boolean? = true
): String
```

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

### PlaybackProgressInfo Constructor

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

The constructor for the PlaybackProgressInfo class.

```kotlin
common
constructor(
    canSeek: Boolean,
    item: BaseItemDto? = null,
    itemId: UUID,
    sessionId: String? = null,
    mediaSourceId: String? = null,
    audioStreamIndex: Int? = null,
    subtitleStreamIndex: Int? = null,
    isPaused: Boolean,
    isMuted: Boolean,
    positionTicks: Long? = null,
    playbackStartTimeTicks: Long? = null,
    volumeLevel: Int? = null,
    brightness: Int? = null,
    aspectRatio: String? = null,
    playMethod: PlayMethod,
    liveStreamId: String? = null,
    playSessionId: String? = null,
    repeatMode: RepeatMode,
    playbackOrder: PlaybackOrder,
    nowPlayingQueue: List<QueueItem>? = null,
    playlistItemId: String? = null
)
```