AudioListener

AudioListenerインターフェースは特定の人物が聞いている音場の位置と方向を表します、そしてそれはaudio spatializationに使用されます。すべてのPannerNodeは、BaseAudioContext.listener属性に格納されているAudioListenerに関連して空間化されます。

コンテキストごとにリスナーは1つだけであり、AudioNodeではないことに注意することが重要です。

We see the position, up and front vectors of an AudioListener, with the up and front vectors at 90° from the other.

Properties

親であるAudioNodeの属性を継承します。

position、forward、およびupの値は、さまざまな構文を使用して設定および取得されます。 値の取得は、例えばAudioListener.positionXにアクセスすることによって行われ、同じプロパティの設定はAudioListener.positionX.valueによって行われます。 これらの値が読み取り専用とマークされていないのはこのためです。つまり、仕様のIDLにはこれらの値が表示されます。

AudioListener.positionX
右直交座標系におけるリスナーの水平位置を表します。 デフォルトは0です。
AudioListener.positionY
右直交座標系におけるリスナーの垂直位置を表します。 デフォルトは0です。
AudioListener.positionZ
右直交座標系におけるリスナーの縦方向(前後)の位置を表します。 デフォルトは0です。
AudioListener.forwardX
ポジション(positionX, positionY,および positionZ)の値と同じ直交座標系におけるリスナーの前方向の水平位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは0です。
AudioListener.forwardY
ポジション(positionX, positionY,および positionZ)の値と同じ直交座標系におけるリスナーの前方方向の垂直位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは0です。
AudioListener.forwardZ
ポジション(positionX, positionY,および positionZ)の値と同じ直交座標系でのリスナーの前方向の前後(前後)の位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは-1です。
AudioListener.upX
ポジション(positionX, positionY,および positionZ)と同じ直交座標系でのリスナーの前方向の前後(前後)の位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは-1です。
AudioListener.upY
ポジション(positionX, positionY,および positionZ)の値と同じ直交座標系における、リスナーの頭のてっぺんの垂直位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは1です。
AudioListener.upZ
ポジション(positionX, positionY,および positionZ)の値と同じ直交座標系における、リスナーの頭の上端の縦方向(前後)の位置を表します。 順方向と上方向の値は互いに線形的に独立しています。 デフォルトは0です。

Methods

親であるAudioNodeのメソッドを継承します。

Deprecated features

AudioListener.dopplerFactor
doppler effect(ドップラー効果)をレンダリングするときに使用するピッチシフトの量を表すdouble値です。
AudioListener.speedOfSound
音速をメートル単位で表したdouble値です。
AudioListener.setOrientation()
リスナーの向きを設定します。
AudioListener.setPosition()
リスナーの位置を設定します。

この仕様の以前のバージョンでは、dopplerFactorおよびspeedOfSoundプロパティとsetPosition()メソッドを使用して、ダウンストリームに接続された AudioBufferSourceNode に適用されるドップラー効果を制御できました — これらは PannerNode と AudioListener の相対速度に応じて上下にピッチが変わります。 これらの機能には多くの問題がありました。

  • Only AudioBufferSourceNodes were pitched up or down, not other source nodes.
  • 他のソースノードではなく、AudioBufferSourceNodeだけが上下にピッチされました。
  • AudioBufferSourceNodeが複数のPannerNodeに接続されている場合に採用する動作は不明でした。
  • パンナーとリスナーのベロシティはAudioParamではなかったため、ピッチの変更はスムーズに適用できず、オーディオグリッチが発生しました。

これらの問題のため、これらのプロパティとメソッドは削除されました。

setOrientation() およびsetPosition() メソッドは、それらのプロパティ値を同等に設定することで置き換えられました。 例えば、setPosition(x, y, z)は、それぞれpositionX.value, positionY.valueおよび positionZ.valueを設定することによって実現できます。

Example

In the following example, you can see an example of how the createPanner() method, AudioListener  and PannerNode would be used to control audio spatialisation. Generally you will define the position in 3D space that your audio listener and panner (source) occupy initially, and then update the position of one or both of these as the application is used. You might be moving a character around inside a game world for example, and wanting delivery of audio to change realistically as your character moves closer to or further away from a music player such as a stereo. In the example you can see this being controlled by the functions moveRight(), moveLeft(), etc., which set new values for the panner position via the PositionPanner() function.

To see a complete implementation, check out our panner-node example (view the source code) — this demo transports you to the 2.5D "Room of metal", where you can play a track on a boom box and then walk around the boom box to see how the sound changes!

Note how we have used some feature detection to either give the browser the newer property values (like AudioListener.forwardX) for setting position, etc. if it supports those, or older methods (like AudioListener.setOrientation()) if it still supports those but not the new properties.

// set up listener and panner position information
var WIDTH = window.innerWidth;
var HEIGHT = window.innerHeight;

var xPos = Math.floor(WIDTH/2);
var yPos = Math.floor(HEIGHT/2);
var zPos = 295;

// define other variables

var AudioContext = window.AudioContext || window.webkitAudioContext;
var audioCtx = new AudioContext();

var panner = audioCtx.createPanner();
panner.panningModel = 'HRTF';
panner.distanceModel = 'inverse';
panner.refDistance = 1;
panner.maxDistance = 10000;
panner.rolloffFactor = 1;
panner.coneInnerAngle = 360;
panner.coneOuterAngle = 0;
panner.coneOuterGain = 0;

if(panner.orientationX) {
  panner.orientationX.setValueAtTime(1, audioCtx.currentTime);
  panner.orientationY.setValueAtTime(0, audioCtx.currentTime);
  panner.orientationZ.setValueAtTime(0, audioCtx.currentTime);
} else {
  panner.setOrientation(1,0,0);
}

var listener = audioCtx.listener;

if(listener.forwardX) {
  listener.forwardX.setValueAtTime(0, audioCtx.currentTime);
  listener.forwardY.setValueAtTime(0, audioCtx.currentTime);
  listener.forwardZ.setValueAtTime(-1, audioCtx.currentTime);
  listener.upX.setValueAtTime(0, audioCtx.currentTime);
  listener.upY.setValueAtTime(1, audioCtx.currentTime);
  listener.upZ.setValueAtTime(0, audioCtx.currentTime);
} else {
  listener.setOrientation(0,0,-1,0,1,0);
}

var source;

var play = document.querySelector('.play');
var stop = document.querySelector('.stop');

var boomBox = document.querySelector('.boom-box');

var listenerData = document.querySelector('.listener-data');
var pannerData = document.querySelector('.panner-data');

leftBound = (-xPos) + 50;
rightBound = xPos - 50;

xIterator = WIDTH/150;

// listener will always be in the same place for this demo

if(listener.positionX) {
  listener.positionX.setValueAtTime(xPos, audioCtx.currentTime);
  listener.positionY.setValueAtTime(yPos, audioCtx.currentTime);
  listener.positionZ.setValueAtTime(300, audioCtx.currentTime);
} else {
  listener.setPosition(xPos,yPos,300);
}

listenerData.innerHTML = 'Listener data: X ' + xPos + ' Y ' + yPos + ' Z ' + 300;

// panner will move as the boombox graphic moves around on the screen
function positionPanner() {
  if(panner.positionX) {
    panner.positionX.setValueAtTime(xPos, audioCtx.currentTime);
    panner.positionY.setValueAtTime(yPos, audioCtx.currentTime);
    panner.positionZ.setValueAtTime(zPos, audioCtx.currentTime);
  } else {
    panner.setPosition(xPos,yPos,zPos);
  }
  pannerData.innerHTML = 'Panner data: X ' + xPos + ' Y ' + yPos + ' Z ' + zPos;
}

Note: In terms of working out what position values to apply to the listener and panner, to make the sound appropriate to what the visuals are doing on screen, there is quite a bit of math involved, but you will soon get used to it with a bit of experimentation.

Specifications

Specification Status Comment
Web Audio API
AudioListener の定義
草案  

Browser compatibility

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewAndroid 版 ChromeAndroid 版 FirefoxAndroid 版 OperaiOSのSafariSamsung Internet
AudioListenerChrome 完全対応 14Edge 完全対応 ありFirefox 完全対応 25IE 未対応 なしOpera 完全対応 15Safari 完全対応 6WebView Android 完全対応 ありChrome Android 完全対応 18Firefox Android 完全対応 26Opera Android 完全対応 14Safari iOS 完全対応 ありSamsung Internet Android 完全対応 あり
dopplerFactor
非推奨
Chrome 未対応 14 — 56Edge 完全対応 12Firefox 未対応 25 — 63IE 未対応 なしOpera 未対応 15 — 43Safari 完全対応 6WebView Android 未対応 ? — 56Chrome Android 未対応 18 — 56Firefox Android 未対応 26 — 63Opera Android 未対応 14 — 43Safari iOS ? Samsung Internet Android 完全対応 あり
forwardXChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
forwardYChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
forwardZChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
positionXChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
positionYChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
positionZChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
setOrientation
非推奨非標準
Chrome 完全対応 14Edge 完全対応 18Firefox 完全対応 25IE 未対応 なしOpera 完全対応 15Safari 完全対応 6WebView Android 完全対応 ありChrome Android 完全対応 18Firefox Android 完全対応 26Opera Android 完全対応 14Safari iOS 完全対応 ありSamsung Internet Android 完全対応 あり
setPosition
非推奨非標準
Chrome 完全対応 14Edge 完全対応 12Firefox 完全対応 25IE 未対応 なしOpera 完全対応 15Safari 完全対応 6WebView Android 完全対応 ありChrome Android 完全対応 18Firefox Android 完全対応 26Opera Android 完全対応 14Safari iOS 完全対応 ありSamsung Internet Android 完全対応 あり
speedOfSound
非推奨
Chrome 未対応 14 — 56Edge 完全対応 12Firefox 未対応 25 — 63IE 未対応 なしOpera 未対応 15 — 43Safari 完全対応 6WebView Android 未対応 ? — 56Chrome Android 未対応 18 — 56Firefox Android 未対応 26 — 63Opera Android 未対応 14 — 43Safari iOS ? Samsung Internet Android 完全対応 あり
upXChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
upYChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし
upZChrome 完全対応 52Edge 完全対応 ありFirefox 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
IE 未対応 なしOpera 完全対応 39Safari 未対応 なしWebView Android 完全対応 52Chrome Android 完全対応 52Firefox Android 未対応 なし
補足
未対応 なし
補足
補足 Supports a deprecated way of setting orientation - the setOrientation() method.
Opera Android 完全対応 41Safari iOS ? Samsung Internet Android 未対応 なし

凡例

完全対応  
完全対応
未対応  
未対応
実装状況不明  
実装状況不明
非標準。ブラウザー間の互換性が低い可能性があります。
非標準。ブラウザー間の互換性が低い可能性があります。
非推奨。新しいウェブサイトでは使用しないでください。
非推奨。新しいウェブサイトでは使用しないでください。
実装ノートを参照してください。
実装ノートを参照してください。

See also