Interface RealtimeEvents

The events emitted by RealtimeClient.

interface RealtimeEvents {
    close: [];
    error: [Error];
    open: [];
    playStateChange: [boolean];
    reconnect: [number];
    stale: [number];
    state: [YnisonState];
    trackChange: [TrackChangeEvent];
}

Properties

close: []

The client stopped and will not reconnect.

error: [Error]

A recoverable error occurred; the client will reconnect if running.

open: []

A session was established (handshake completed).

playStateChange: [boolean]

Playback was paused or resumed.

reconnect: [number]

A reconnection is scheduled after the given delay (ms).

stale: [number]

The session went silent past staleTimeoutMs and is being torn down; the argument is how long (ms) no frame had arrived.

A raw player-state frame arrived.

The current track changed.