The PeriodicWave()
constructor of the Web Audio API creates a new PeriodicWave
object instance.
PeriodicWave()
Syntax
new PeriodicWave(context, options);
Parameters
-
context
-
A
BaseAudioContext
representing the audio context you want the node to be associated with. -
options
Optional -
A
PeriodicWaveOptions
dictionary object defining the properties you want thePeriodicWave
to have (It also inherits the options defined in the PeriodicWaveConstraints dictionary.):-
real
: AFloat32Array
containing the cosine terms that you want to use to form the wave (equivalent to thereal
parameter ofBaseAudioContext.createPeriodicWave
). -
imag
: AFloat32Array
containing the sine terms that you want to use to form the wave (equivalent to theimag
parameter ofBaseAudioContext.createPeriodicWave
). -
channelCount
: Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. (SeeAudioNode.channelCount
for more information.) Its usage and precise definition depend on the value ofchannelCountMode
. -
channelCountMode
: Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. (SeeAudioNode.channelCountMode
for more information including default values.) -
channelInterpretation
: Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen. The possible values are"speakers"
or"discrete"
. (SeeAudioNode.channelCountMode
for more information including default values.)
-
Return value
A new PeriodicWave
object instance.
Examples
var real = new Float32Array(2); var imag = new Float32Array(2); var ac = new AudioContext(); real[0] = 0; imag[0] = 0; real[1] = 1; imag[1] = 0; var options = { real : real, imag : imag, disableNormalization : false } var wave = new PeriodicWave(ac, options);
Specifications
Specification |
---|
Web Audio API # dom-periodicwave-periodicwave |
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 | |
PeriodicWave |
55
Before Chrome 59, the default values were not supported.
|
79
|
53
|
No
|
42
|
14.1
|
55
Before Chrome 59, the default values were not supported.
|
55
Before Chrome 59, the default values were not supported.
|
53
|
42
|
14.5
|
6.0
Before Samsung Internet 7.0, the default values were not supported.
|
© 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/PeriodicWave/PeriodicWave