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

Constructors

Link copied to clipboard
constructor(api: ApiClient, socketReconnectPolicy: SocketReconnectPolicy, socketConnectionFactory: SocketConnectionFactory)

Properties

Link copied to clipboard
open override val state: ERROR CLASS: Symbol not found for StateFlow<org/jellyfin/sdk/api/sockets/SocketApiState>

Flow indicating the current status of the WebSocket connection.

Functions

Link copied to clipboard

Notify this SocketApi instance of changes in the parent ApiClient.

Link copied to clipboard
open override fun <T : ERROR CLASS: Symbol not found for OutboundWebSocketMessage> subscribe(messageType: KClass<T>): ERROR CLASS: Symbol not found for Flow<T>

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

abstract fun <T : ERROR CLASS: Symbol not found for OutboundWebSocketMessage> subscribe(messageType: KClass<T>): ERROR CLASS: Symbol not found for Flow<T>

Subscribe to a specific WebSocket message type.

Link copied to clipboard
inline fun <T : ERROR CLASS: Symbol not found for OutboundWebSocketMessage> SocketApi.subscribe(): ERROR CLASS: Symbol not found for Flow<T>

Subscribe to a specific WebSocket message type.

Link copied to clipboard
open override fun subscribeAll(): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for OutboundWebSocketMessage>

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

Link copied to clipboard
inline fun SocketApi.subscribeGeneralCommand(command: ERROR CLASS: Symbol not found for GeneralCommandType): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for GeneralCommandMessage>

Subscribe to a specific GeneralCommandType message.

Link copied to clipboard
inline fun SocketApi.subscribeGeneralCommands(commands: Set<ERROR CLASS: Symbol not found for GeneralCommandType> = GeneralCommandType.values().toSet()): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for GeneralCommandMessage>

Subscribe to specific GeneralCommandType messages.

Link copied to clipboard
inline fun SocketApi.subscribePlayStateCommand(command: ERROR CLASS: Symbol not found for PlaystateCommand): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for PlaystateMessage>

Subscribe to a specific PlaystateCommand message.

Link copied to clipboard
inline fun SocketApi.subscribePlayStateCommands(commands: Set<ERROR CLASS: Symbol not found for PlaystateCommand> = PlaystateCommand.values().toSet()): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for PlaystateMessage>

Subscribe to specific PlaystateCommand messages.

Link copied to clipboard
inline fun SocketApi.subscribeSyncPlayCommand(command: ERROR CLASS: Symbol not found for SendCommandType): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for SyncPlayCommandMessage>

Subscribe to a specific SendCommandType message.

Link copied to clipboard
inline fun SocketApi.subscribeSyncPlayCommands(commands: Set<ERROR CLASS: Symbol not found for SendCommandType> = SendCommandType.values().toSet()): ERROR CLASS: Symbol not found for Flow<ERROR CLASS: Symbol not found for SyncPlayCommandMessage>

Subscribe to specific SendCommandType messages.