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

PlayRequest

@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)

Instructs a session to play an item.

Constructors

constructor(sessionId: String, playCommand: PlayCommand, itemIds: Collection<UUID>, startPositionTicks: Long? = null, mediaSourceId: String? = null, audioStreamIndex: Int? = null, subtitleStreamIndex: Int? = null, startIndex: Int? = null)

Properties

audioStreamIndex

@SerialName(value = "audioStreamIndex")

val audioStreamIndex: Int?

Optional. The index of the audio stream to play.

@SerialName(value = "itemIds")

val itemIds: Collection<UUID>

The ids of the items to play, comma delimited.

@SerialName(value = "mediaSourceId")

val mediaSourceId: String?

Optional. The media source id.

@SerialName(value = "playCommand")

val playCommand: PlayCommand

The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.

@SerialName(value = "sessionId")

val sessionId: String

The session id.

@SerialName(value = "startIndex")

val startIndex: Int?

Optional. The start index.

startPositionTicks

@SerialName(value = "startPositionTicks")

val startPositionTicks: Long?

The starting position of the first item.

subtitleStreamIndex

@SerialName(value = "subtitleStreamIndex")

val subtitleStreamIndex: Int?

Optional. The index of the subtitle stream to play.