PeriodicWave()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.

Web Audio API の PeriodicWave() コンストラクターは、新しい PeriodicWave オブジェクトのインスタンスを作成します。

構文

new PeriodicWave(context)
new PeriodicWave(context, options)

引数

context

ノードを関連付ける音声コンテキストを表す BaseAudioContext です。

options 省略可

PeriodicWave に持たせるプロパティを定義する PeriodicWaveOptions の辞書オブジェクトです。(辞書 PeriodicWaveConstraints で定義されるオプションも継承しています)

real: 波形を作るための余弦 (コサイン) の項を格納した Float32Array です。 (BaseAudioContext.createPeriodicWave の引数 real に相当します)
imag: 波形を作るための正弦 (サイン) の項を格納した Float32Array です。 (BaseAudioContext.createPeriodicWave の引数 imag に相当します)
channelCount: ノードへの入力のアップミキシングとダウンミキシングを行う際に何個のチャンネルを用いるかを決めるために用いる整数です。(詳しくは AudioNode.channelCount を参照してください) 利用法と正確な定義は channelCountMode の値によります。
channelCountMode: ノードの入力と出力でチャンネルを対応させる方法を表す列挙値です。(デフォルト値など詳しくは AudioNode.channelCountMode を参照してください)
channelInterpretation: チャンネルの意味を表す列挙値です。これによりアップミキシングとダウンミキシングをどのように行うかを決定します。取りうる値は "speakers" および "discrete" です。(デフォルト値など詳しくは AudioNode.channelCountMode を参照してください)

返値

新しい PeriodicWave オブジェクトのインスタンスを返します。

例

const real = new Float32Array(2);
const imag = new Float32Array(2);
const ac = new AudioContext();

real[0] = 0;
imag[0] = 0;
real[1] = 1;
imag[1] = 0;

const wave = new PeriodicWave(ac, {
  real,
  imag,
  disableNormalization: false,
});

仕様書

Specification
Web Audio API # dom-periodicwave-periodicwave

ブラウザーの互換性

BCD tables only load in the browser