AudioData: allocationSize() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Note: This feature is available in Dedicated Web Workers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Syntax
allocationSize(options)
Parameters
options-
An object containing the following:
planeIndex-
The index of the plane to return the size of.
frameOffsetOptional-
An integer giving an offset into the plane data indicating which plane to begin from. Defaults to
0. frameCountOptional-
An integer giving the number of frames to return the size of. If omitted then all frames in the plane will be used, beginning with the frame specified in
frameOffset.
Return value
An integer containing the number of bytes needed to hold the samples described by options.
Examples
The following example gets the size of the plane at index 1.
let size = AudioData.allocationSize({ planeIndex: 1 });
Specifications
| Specification |
|---|
| WebCodecs # dom-audiodata-allocationsize |
Browser compatibility
BCD tables only load in the browser