Rate this page:

WebSocketEvents

Constants

CLOSE

Copy URL

Triggered when the WebSocket connection is closed. WebSocket.onclose is called right before any other handlers.

Parameters

  • WebSocket close code.

  • reason:

    string

    Reason why the connection is closed.

  • wasClean:

    boolean

    Whether the connection is cleanly closed.

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

ERROR

Copy URL

Triggers when an error occurs during the WebSocket connection. WebSocket.onerror is called right before any other handlers.

Parameters

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

MEDIA_ENDED

Copy URL

Triggers after the end of the audio stream sent by a third party through a WebSocket (1 second of silence).

Parameters

  • Information about the audio stream that can be obtained after the stream stops or pauses (1 second of silence).

  • tag:

    string

    Special tag to name audio streams sent over one WebSocket connection. With it, one can send 2 audios to 2 different calls at the same time.

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

MEDIA_STARTED

Copy URL

Triggered when the audio stream sent by a third party through a WebSocket is started playing.

Parameters

  • customParameters:

    {[key: string]: string}

    Custom data.

  • tag:

    string

    Special tag to name audio streams sent over one WebSocket connection. With it, one can send 2 audios to 2 different calls at the same time.

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

MESSAGE

Copy URL

Triggered when a message is received by a target object. WebSocket.onmessage is called right before any other handlers.

Parameters

  • data:

    string

    The data sent by the message emitter.

  • text:

    string

    Optional

    TODO: need to check is there really a 'data' or a 'text' properties?

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

OPEN

Copy URL

Triggered when the WebSocket connection is opened. WebSocket.onopen is called right before any other handlers.

Parameters

  • websocket:

    WebSocket

    WebSocket object that triggered the event.