Skip to main content

WebSocket Engine

The WebSocket audio engine starts a WebSocket server and processes the received audio buffer packets.

Configuration​

Properties​

Inherits properties from its parent, Engine.

graph​

Type: Graph Config

The configuration of the graph that is set in the engine.

port​

Type: UInt

The port that the WebSocket server will use to receive audio packets. This will be used when start is called.

sampleRate​

Type: UInt

The sample rate that the clients must use

Actions​

Inherits actions from its parent, Engine.

start​

Starts the audio engine.

Parameters​

None

Return Value​

None.

stop​

Stops the audio engine.

Events​

Inherits events from its parent, Engine.