Rate this page:

WebSocket

Represents a WebSocket object that provides the API for creating and managing an outgoing or incoming WebSocket connection, as well as for sending and receiving data to/from it.

Constructors

constructor

Copy URL

Parameters

  • url:

    string

  • protocols:

    string

    Optional

Methods

addEventListener

Copy URL
addEventListener(event: 

WebSocketEvents

,
callback:

Function

):

void

Adds a handler for the specified WebSocketEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called

Parameters

Returns

  • type:

    void

close

Copy URL
close(code: 

WebsocketCloseCode

,
reason:

string

):

void

Closes the WebSocket connection or connection attempt.

Parameters

  • Optional

    WebSocket close code.

  • reason:

    string

    Optional

    Reason why the connection is closed.

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 

WebSocketEvents

,
callback:

Function

):

void

Removes a handler for the specified WebSocketEvents event

Parameters

Returns

  • type:

    void

send

Copy URL
send(data: 

string

):

void

Enqueues the specified data to be transmitted over the WebSocket connection.

Parameters

  • data:

    string

    Data to send through a WebSocket.

Returns

  • type:

    void

sendMediaTo

Copy URL
sendMediaTo(targetMediaUnit: 

VoxMediaUnit

,
parameters:

SendMediaParameters

):

void

Starts sending media with the specified parameters to the target unit. WebSocket works in real time and the recommended duration of one audio chunk is 20ms.

Parameters

Returns

  • type:

    void

stopMediaTo

Copy URL
stopMediaTo(targetMediaUnit: 

VoxMediaUnit

):

void

Stops sending media with the specified parameters to the target unit.

Parameters

  • targetMediaUnit:

    VoxMediaUnit

    Media unit that stops receiving media.

Returns

  • type:

    void

Props

onclose

Copy URL
onclose: 

(ev: WebSocketEvents.CLOSE) => any

|

null

Event handler to call when the connection is closed.

onerror

Copy URL
onerror: 

(ev: WebSocketEvents.ERROR) => any

|

null

Event handler to call when an error occurs.

onmediaended

Copy URL
onmediaended: 

(ev: WebSocketEvents.MEDIA_ENDED) => any,null

Event handler to call after the end of the audio stream.

onmediastarted

Copy URL
onmediastarted: 

(ev: WebSocketEvents.MEDIA_STARTED) => any,null

Event handler to call when the audio stream is started playing.

onmessage

Copy URL
onmessage: 

(ev: WebSocketEvents.MESSAGE) => any

|

null

Event handler to call when a message is received.

onopen

Copy URL
onopen: 

(ev: WebSocketEvents.OPEN) => any

|

null

Event handler to call when the connection is open (ready to send and receive data).

readyState

Copy URL
readyState: 

WebSocketReadyState

Returns the current state of the WebSocket connection.

url

Copy URL
url: 

string

Returns the absolute URL of the WebSocket. For outgoing connection, it is the URL to which to connect; for incoming, it is the WebSocket session URL.