kotlin-browser/web.codecs/AudioData

AudioData

open class AudioData(init: AudioDataInit) : Transferable, Serializable, JsCloseable(source)

The AudioData interface of the WebCodecs API represents an audio sample.

MDN Reference

Constructors

AudioData

constructor(init: AudioDataInit)

Properties

duration

val duration: UInt53

The duration read-only property of the AudioData interface returns the duration in microseconds of this AudioData object.

format

val format: AudioSampleFormat?

The format read-only property of the AudioData interface returns the sample format of the AudioData object.

numberOfChannels

val numberOfChannels: Int

The numberOfChannels read-only property of the AudioData interface returns the number of channels in the AudioData object.

numberOfFrames

val numberOfFrames: Int

The numberOfFrames read-only property of the AudioData interface returns the number of frames in the AudioData object.

sampleRate

val sampleRate: Float

The sampleRate read-only property of the AudioData interface returns the sample rate in Hz.

timestamp

val timestamp: Int53

The timestamp read-only property of the AudioData interface returns the timestamp of this AudioData object.

Functions

allocationSize

fun allocationSize(options: AudioDataCopyToOptions): Int

The allocationSize() method of the AudioData interface returns the size in bytes required to hold the current sample as filtered by options passed into the method.

clone

fun clone(): AudioData

The clone() method of the AudioData interface creates a new AudioData object with reference to the same media resource as the original.

open override fun close()

The close() method of the AudioData interface clears all states and releases the reference to the media resource.

copyTo

fun copyTo(destination: AllowSharedBufferSource, options: AudioDataCopyToOptions)

The copyTo() method of the AudioData interface copies a plane of an AudioData object to a destination buffer.