VoiceWebSocket

classe · Source

Represents a Voice Connection's WebSocket.

Extends: EventEmitter

Properties

connection

connection: VoiceConnection

The Voice Connection that this WebSocket serves Source

attempts

attempts: number

How many connection attempts have been made Source

client

readonly

client: Client

The client of this voice WebSocket Source

ws

ws: WebSocket

The actual WebSocket used to connect to the Voice WebSocket Server. Source

Methods

reset

reset()

Resets the current WebSocket. Source

connect

connect()

Starts connecting to the Voice WebSocket Server. Source

send

send(data: string): Promise<string>

Sends data to the WebSocket if it is open. Parameters

Name	Type	Description
data	string	The data to send to the WebSocket

Returns: Promise<string>Source

sendPacket

async

async sendPacket(packet: Object): Promise<string>

JSON.stringify's a packet and then sends it to the WebSocket Server. Parameters

Name	Type	Description
packet	Object	The packet to send

Returns: Promise<string>Source

onOpen

onOpen()

Called whenever the WebSocket opens. Source

onMessage

onMessage(event: MessageEvent): void

Called whenever a message is received from the WebSocket. Parameters

Name	Type	Description
event	MessageEvent	The message event that was received

Returns: voidSource

onClose

onClose(event: CloseEvent)

Called whenever the connection to the WebSocket server is lost. Parameters

Name	Type	Description
event	CloseEvent	The WebSocket close event
Source

onError

onError(error: Error)

Called whenever an error occurs with the WebSocket. Parameters

Name	Type	Description
error	Error	The error that occurred
Source

onPacket

onPacket(packet: Object)

Called whenever a valid packet is received from the WebSocket. Parameters

Name	Type	Description
packet	Object	The received packet
Source

setHeartbeat

setHeartbeat(interval: number)

Sets an interval at which to send a heartbeat packet to the WebSocket. Parameters

Name	Type	Description
interval	number	The interval at which to send a heartbeat packet
Source

clearHeartbeat

clearHeartbeat()

Clears a heartbeat interval, if one exists. Source

sendHeartbeat

sendHeartbeat()

Sends a heartbeat packet. Source

Events

ready

ready: unknown

Emitted once the voice WebSocket receives the ready packet. Parameters

Name	Type	Description
packet	Object	The received packet
Source

sessionDescription

sessionDescription: unknown

Emitted once the Voice Websocket receives a description of this voice session. Parameters

Name	Type	Description
packet	Object	The received packet
Source

startSpeaking

startSpeaking: unknown

Emitted whenever a speaking packet is received. Parameters

Name	Type	Description
data	Object
Source

startStreaming

startStreaming: unknown

Emitted whenever a streaming packet is received. Parameters

Name	Type	Description
data	Object
Source

unknownPacket

unknownPacket: unknown

Emitted when an unhandled packet is received. Parameters

Name	Type	Description
packet	Object
Source

warn

warn: unknown

Emitted whenever the voice WebSocket encounters a non-fatal error. Parameters

Name	Type	Description
warn	string	The warning
Source