kotlin-browser/web.codecs/AudioEncoder

AudioEncoder

open class AudioEncoder(init: AudioEncoderInit) : EventTarget, JsCloseable(source)

The AudioEncoder interface of the WebCodecs API encodes AudioData objects. Available only in secure contexts.

MDN Reference

Constructors

AudioEncoder

constructor(init: AudioEncoderInit)

Types

Companion

object Companion

Properties

encodeQueueSize

external val encodeQueueSize: Int

The encodeQueueSize read-only property of the AudioEncoder interface returns the number of pending encode requests in the queue.

ondequeue

external var ondequeue: EventHandler<Event, AudioEncoder, AudioEncoder>?

MDN Reference

state

external val state: CodecState

The state read-only property of the AudioEncoder interface returns the current state of the underlying codec.

Functions

open external override fun close()

The close() method of the AudioEncoder interface ends all pending work and releases system resources.

configure

external fun configure(config: AudioEncoderConfig)

The configure() method of the AudioEncoder interface enqueues a control message to configure the audio encoder for encoding chunks.

dispatchEvent

open external fun dispatchEvent(event: Event): Boolean

encode

external fun encode(data: AudioData)

The encode() method of the AudioEncoder interface enqueues a control message to encode a given AudioData object.

flush

inline suspend fun AudioEncoder.flush()

The flush() method of the AudioEncoder interface returns a Promise that resolves once all pending messages in the queue have been completed.

flushAsync

external fun flushAsync(): Promise<Void>

The flush() method of the AudioEncoder interface returns a Promise that resolves once all pending messages in the queue have been completed.

reset

external fun reset()

The reset() method of the AudioEncoder interface resets all states including configuration, control messages in the control message queue, and all pending callbacks.

when

external fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>