AudioEncoder: AudioEncoder() constructor
The AudioEncoder()
constructor creates a new AudioEncoder
object with the provided init.output
callback assigned as the output callback, the provided init.error
callback as the error callback, and the AudioEncoder.state
set to "unconfigured"
.
Syntax
Parameters
-
init
-
An object containing two required callbacks.
-
output
-
A callback which takes a EncodedAudioChunk
object as the first argument, and an optional metadata object as the second. The metadata object has one member, decoderConfig
which has an object as its value containing:
-
codec
-
A string containing a valid codec string.
-
sampleRate
-
An integer representing the number of frame samples per second.
-
numberOfChannels
-
An integer representing the number of audio channels.
description
Optional
-
An ArrayBuffer
, a TypedArray
, or a DataView
containing a sequence of codec specific bytes, commonly known as extradata.
-
error
-
A callback which takes an Error
object as its only argument.
Examples
In the following example an AudioEncoder
is created with the two required callback functions, one to deal with the decoded frame and the other to handle errors.
const audioEncoder = new AudioEncoder({
output: processAudio,
error: onEncoderError,
});
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
AudioEncoder |
94 |
94 |
No |
No |
80 |
No |
94 |
94 |
No |
66 |
No |
17.0 |