Skip to content

AudioEncoder.md

Latest commit

 

History

History
43 lines (31 loc) · 1.5 KB

AudioEncoder.md

File metadata and controls

43 lines (31 loc) · 1.5 KB
Raw

AudioEncoder

Namespace: SpawnDev.SpawnJS.JSObjects
Inheritance: SpawnJSObject -> AudioEncoder
MDN Reference: AudioEncoder - MDN

The AudioEncoder interface of the WebCodecs API encodes AudioData objects into encoded audio chunks. It provides hardware-accelerated audio encoding for real-time applications.

Constructors

Signature Description
AudioEncoder(SpawnJSObjectReference _ref) Deserialization constructor.

Properties

Property Type Description
EncodeQueueSize int Number of pending encode requests.
State string Current state: "unconfigured", "configured", "closed".

Static Methods

Method Return Type Description
IsConfigSupported(object config) Task<object> Checks whether the given configuration is supported.

Methods

Method Return Type Description
Configure(object config) void Configures the encoder (codec, sampleRate, numberOfChannels, bitrate).
Encode(object audioData) void Encodes audio data.
Flush() Task Flushes all pending encodes.
Reset() void Resets the encoder, discarding pending work.
Close() void Closes the encoder permanently.

Example

// Note: WebCodecs audio encoders are constructed via JS.New with output/error callbacks
// Encoded chunks are delivered through the output callback