jellyfin-model/org.jellyfin.sdk.model.api/PlayRequest

PlayRequest

@Serializable
data class PlayRequest(val itemIds: List<UUID>? = null, val startPositionTicks: Long? = null, val playCommand: PlayCommand, val controllingUserId: UUID, val subtitleStreamIndex: Int? = null, val audioStreamIndex: Int? = null, val mediaSourceId: String? = null, val startIndex: Int? = null)

Class PlayRequest.

Constructors

Link copied to clipboard
constructor(itemIds: List<UUID>? = null, startPositionTicks: Long? = null, playCommand: PlayCommand, controllingUserId: UUID, subtitleStreamIndex: Int? = null, audioStreamIndex: Int? = null, mediaSourceId: String? = null, startIndex: Int? = null)

Properties

Link copied to clipboard
@SerialName(value = "AudioStreamIndex")
val audioStreamIndex: Int?
Link copied to clipboard
@SerialName(value = "ControllingUserId")
val controllingUserId: UUID

The controlling user identifier.

Link copied to clipboard
@SerialName(value = "ItemIds")
val itemIds: List<UUID>?

The item ids.

Link copied to clipboard
@SerialName(value = "MediaSourceId")
val mediaSourceId: String?
Link copied to clipboard
@SerialName(value = "PlayCommand")
val playCommand: PlayCommand

The play command.

Link copied to clipboard
@SerialName(value = "StartIndex")
val startIndex: Int?
Link copied to clipboard
@SerialName(value = "StartPositionTicks")
val startPositionTicks: Long?

The start position ticks that the first item should be played at.

Link copied to clipboard
@SerialName(value = "SubtitleStreamIndex")
val subtitleStreamIndex: Int?
Generated by Dokka
© 2026 Copyright