Skip to content

VonageSocket

Browser-style event subscription (socket.addEventListener('message', cb)).

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:155

Properties

PropertyTypeDescriptionDefined in
binaryType?stringBinary delivery mode — set to 'arraybuffer' by the provider when present.src/providers/io/vonage/VonageAudioSocket.ts:178

Methods

addEventListener()?

optional addEventListener(event, listener): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:172

Browser-style event subscription (socket.addEventListener('message', cb)).

Parameters

ParameterType
eventstring
listenerVonageSocketListener

Returns

void


close()?

optional close(code?, reason?): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:160

Optional close method — the provider never calls it; the app owns the socket.

Parameters

ParameterType
code?number
reason?string

Returns

void


off()?

optional off(event, listener): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:166

Node ws-style event unsubscription.

Parameters

ParameterType
eventstring
listenerVonageSocketListener

Returns

void


on()?

optional on(event, listener): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:163

Node ws-style event subscription (socket.on('message', cb)).

Parameters

ParameterType
eventstring
listenerVonageSocketListener

Returns

void


removeEventListener()?

optional removeEventListener(event, listener): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:175

Browser-style event unsubscription.

Parameters

ParameterType
eventstring
listenerVonageSocketListener

Returns

void


removeListener()?

optional removeListener(event, listener): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:169

Node EventEmitter-style event unsubscription (older ws versions).

Parameters

ParameterType
eventstring
listenerVonageSocketListener

Returns

void


send()

send(data): void;

Defined in: src/providers/io/vonage/VonageAudioSocket.ts:157

Send a text or binary frame to Vonage.

Parameters

ParameterType
datastring | ArrayBufferLike | ArrayBufferView<ArrayBufferLike>

Returns

void

© 2026 CompositeVoice. All rights reserved.

Font size
Contrast
Motion
Transparency