jellyfin-api/org.jellyfin.sdk.api.sockets

Package-level declarations

Types

class OkHttpWebsocketSession(clientOptions: HttpClientOptions, incomingMessageChannel: Channel<String>, context: CoroutineContext) : SocketInstanceConnection

SocketConnectionFactory

fun interface SocketConnectionFactory

SocketInstance

class SocketInstance

SocketInstanceConnection

interface SocketInstanceConnection

Reusable WebSocket connection. Constructed using SocketConnectionFactory.

SocketInstanceState

enum SocketInstanceState : Enum<SocketInstanceState>

Possible states for a SocketInstance.

Functions

addGeneralCommandsListener

inline fun SocketInstance.addGeneralCommandsListener(commands: Set<<Error class: unknown class>> = GeneralCommandType.values().toSet(), stopOnCredentialsChange: Boolean = false, listener: SocketMessageReceiver<<Error class: unknown class>>): SocketListener

Add a listener that listens to certain GeneralCommandType entries in the GeneralCommandMessage.

addGlobalListener

inline fun SocketInstance.addGlobalListener(stopOnCredentialsChange: Boolean = false, listener: SocketMessageReceiver<<Error class: unknown class>>): SocketListener

Add a listener that listens to all message types. If you want to listen for specific messages you can use addListener or addGeneralCommandsListener instead.

addListener

inline fun <T> SocketInstance.addListener(stopOnCredentialsChange: Boolean = false, listener: SocketMessageReceiver<T>): SocketListener

Add a listener that listens to a specific message type.

addPlayStateCommandsListener

inline fun SocketInstance.addPlayStateCommandsListener(commands: Set<<Error class: unknown class>> = PlaystateCommand.values().toSet(), stopOnCredentialsChange: Boolean = false, listener: SocketMessageReceiver<<Error class: unknown class>>): SocketListener

Add a listener that listens to certain PlaystateCommand entries in the PlayStateMessage.

addSyncPlayCommandsListener

inline fun SocketInstance.addSyncPlayCommandsListener(commands: Set<<Error class: unknown class>> = SendCommandType.values().toSet(), stopOnCredentialsChange: Boolean = false, listener: SocketMessageReceiver<<Error class: unknown class>>): SocketListener

Add a listener that listens to certain SendCommandType entries in the SyncPlayCommandMessage.