Rate this page:

WebSocketEvents

Add the following line to your scenario code to use the events:

require(Modules.WebSocket);

Constants

CLOSE

Copy URL

Event is triggered when the WebSocket connection is closed. WebSocket.onclose will be called right before any other handlers.

Parameters

  • WebSocket close code.

  • reason:

    string

    Reason why the connection was closed.

  • wasClean:

    boolean

    Value indicating whether the connection was cleanly closed.

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

ERROR

Copy URL

Event is triggered when an error occurs on the WebSocket connection. WebSocket.onerror will be called right before any other handlers.

Parameters

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

MEDIA_ENDED

Copy URL

Event is triggered 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-sec silence).

  • tag:

    string

    Special tag to name audio streams sent over one WebSocket connection. Using 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

Event is 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. Using 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

Event is triggered when a message is received by a target object. WebSocket.onmessage will be called right before any other handlers.

Parameters

  • data:

    string

    The data sent by the message emitter.

  • websocket:

    WebSocket

    WebSocket object that triggered the event.

OPEN

Copy URL

Event is triggered when the WebSocket connection is opened. WebSocket.onopen will be called right before any other handlers.

Parameters

  • websocket:

    WebSocket

    WebSocket object that triggered the event.