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.
AudioData.allocationSize()
Syntax
allocationSize(options)
Parameters
-
options
-
An object containing the following:
-
planeIndex
-
The index of the plane to return the size of.
-
frameOffset
Optional -
An integer giving an offset into the plane data indicating which plane to begin from. Defaults to
0
. -
frameCount
Optional -
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
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
allocationSize |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/AudioData/allocationSize