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

DefaultSocketApi

class DefaultSocketApi(api: ApiClient, socketReconnectPolicy: SocketReconnectPolicy, socketConnectionFactory: SocketConnectionFactory) : SocketApi

Implementation of the Jellyfin WebSocket API. Each instance of this class maintains its own connection.

See also

ApiClient.webSocket

Constructors

DefaultSocketApi

constructor(api: ApiClient, socketReconnectPolicy: SocketReconnectPolicy, socketConnectionFactory: SocketConnectionFactory)

Properties

open override val state: StateFlow<SocketApiState>

Flow indicating the current status of the WebSocket connection.

Functions

notifyApiClientUpdate

fun notifyApiClientUpdate()

Notify this SocketApi instance of changes in the parent ApiClient.

open override fun <T : OutboundWebSocketMessage> subscribe(messageType: KClass<T>): Flow<T>

Subscribe to a specific WebSocket message type. Returns a flow that emits each deserialized message of type T.

inline fun <T : OutboundWebSocketMessage> SocketApi.subscribe(): Flow<T>

Subscribe to a specific WebSocket message type.

open override fun subscribeAll(): Flow<OutboundWebSocketMessage>

Subscribe to all incoming WebSocket messages. Returns a flow that emits each deserialized message.

subscribeGeneralCommand

inline fun SocketApi.subscribeGeneralCommand(command: GeneralCommandType): Flow<GeneralCommandMessage>

Subscribe to a specific GeneralCommandType message.

subscribeGeneralCommands

inline fun SocketApi.subscribeGeneralCommands(commands: Set<GeneralCommandType> = GeneralCommandType.values().toSet()): Flow<GeneralCommandMessage>

Subscribe to specific GeneralCommandType messages.

subscribePlayStateCommand

inline fun SocketApi.subscribePlayStateCommand(command: PlaystateCommand): Flow<PlaystateMessage>

Subscribe to a specific PlaystateCommand message.

subscribePlayStateCommands

inline fun SocketApi.subscribePlayStateCommands(commands: Set<PlaystateCommand> = PlaystateCommand.values().toSet()): Flow<PlaystateMessage>

Subscribe to specific PlaystateCommand messages.

subscribeSyncPlayCommand

inline fun SocketApi.subscribeSyncPlayCommand(command: SendCommandType): Flow<SyncPlayCommandMessage>

Subscribe to a specific SendCommandType message.

subscribeSyncPlayCommands

inline fun SocketApi.subscribeSyncPlayCommands(commands: Set<SendCommandType> = SendCommandType.values().toSet()): Flow<SyncPlayCommandMessage>

Subscribe to specific SendCommandType messages.