AudioEncoder
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inDedicated Web Workers.
TheAudioEncoder interface of theWebCodecs API encodesAudioData objects.
In this article
Constructor
AudioEncoder()Creates a new
AudioEncoderobject.
Instance properties
Inherits properties from its parent,EventTarget.
AudioEncoder.encodeQueueSizeRead onlyAn integer representing the number of encode queue requests.
AudioEncoder.stateRead onlyRepresents the state of the underlying codec and whether it is configured for encoding.
Events
dequeueFires to signal a decrease in
AudioEncoder.encodeQueueSize.
Static methods
AudioEncoder.isConfigSupported()Returns a promise indicating whether the provided
AudioEncoderConfigis supported.
Instance methods
Inherits methods from its parent,EventTarget.
AudioEncoder.configure()Enqueues a control message to configure the audio encoder for encoding chunks.
AudioEncoder.encode()Enqueues a control message to encode a given
AudioDataobjects.AudioEncoder.flush()Returns a promise that resolves once all pending messages in the queue have been completed.
AudioEncoder.reset()Resets all states including configuration, control messages in the control message queue, and all pending callbacks.
AudioEncoder.close()Ends all pending work and releases system resources.
Specifications
| Specification |
|---|
| WebCodecs> # audioencoder-interface> |