AudioListener
L'interface AudioListener représente la position et l'orientation de l'unique personne écoutant la scène audio; elle est utilisée dans le cadre d'une spatialisation audio. Tous les PannerNode
(en-US) sont spatialisés par rapport à l'objet AudioListener stocké dans la propriété AudioContext.listener
(en-US).
Il est important de noter qu'il n'y a qu'un seul auditeur par contexte, et qu'il ne s'agit pas d'un AudioNode
.
Propriétés
Hérite des propriétés de son parent, AudioNode
.
Les valeurs de position, d'orientation, et du haut de la tête peuvent être définies et lues à l'aide de différentes syntaxes. Par exemple, l'accès se fait à l'aide de la propriété, AudioListener.positionX
, tandis que la même propriété est définir à l'aide de AudioListener.positionX.value
. C'est pourquoi ces valeurs ne sont pas marquées en lecture seule, bien qu'elles apparaissent comme tel dans la spécification IDL.
AudioListener.positionX
(en-US)- Position de l'auditeur avec des coordonnées cartésiennes selon la règle de la main droite. La valeur par défaut est 0.
AudioListener.positionY
(en-US)- Position verticale de l'auditeur avec des coordonnées cartésiennes selon la règle de la main droite. La valeur par défaut est 0.
AudioListener.positionZ
(en-US)- Position longitudinale (avant et arrière) de l'auditeur avec des coordonnées cartésiennes selon la règle de la main droite. La valeur par défaut est 0.
AudioListener.forwardX
(en-US)- Position horizontale de l'orientation vers l'avant de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0. AudioListener.forwardY
(en-US)- Position verticale de l'orientation vers l'avant de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0. AudioListener.forwardZ
(en-US)- Position longitudinale (avant et arrière) de l'orientation vers l'avant de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0. AudioListener.upX
(en-US)- Position horizontale du haut de la tête de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0. AudioListener.upY
(en-US)- Position verticale du haut de la tête de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0. AudioListener.upZ
(en-US)- Position longitudinale (avant et arrière) du haut de la tête de l'auditeur avec le même système de coordonnées cartésiennnes que les valeurs de position (
positionX
,positionY
, andpositionZ
). Les valeurs de direction vers l'avant et vers le haut sont indépendantes linéairement l'une de l'autre. La valeur par défaut est 0.
Méthodes
Hérite des propriétés de son parent, AudioNode
.
AudioListener.setOrientation()
(en-US)- Définit l'orientation de l'auditeur.
AudioListener.setPosition()
(en-US)- Définit la position de l'auditeur. Consulter Deprecated features pour savoir pourquoi cette méthode est désormais obsolète.
Fonctionnalités obsolètes
AudioListener.dopplerFactor
(en-US)- Nombre flottant à double précision représentant la quantité de "pitch shift" à utiliser pour le rendu d'un effet doppler.
AudioListener.speedOfSound
(en-US)- Nombre flottant à double précision représentant la vitesse du son, en mètres par seconde.
Dans une version précédente de la spécification, les propriétés dopplerFactor
et speedOfSound
et la méthode setPosition()
lpouvaient être utilisés pour contrôler un effet doppler appliqué à un AudioBufferSourceNode
connecté en aval - ils pouvaient être transposés en fonction de la vitesse relative du PannerNode
(en-US), et de l'AudioListener
. Ces fonctionnalités soulevaient un certain nombre de problèmes :
- Seuls les
AudioBufferSourceNode
étaient transposés, pas les autres noeuds source. - Le comportement à adopter lorsqu'un
AudioBufferSourceNode
était connecté à plusieursPannerNode
(en-US) n'était pas clair. - Comme la vélocité du panoramique et de l'auditeur n'étaient pas des
AudioParam
, la modification du pitch ne pouvait pas être appliquée uniformément, ce qui provoquait des irrégularités dans le son.
C'est la raison pour laquelle elles ont été supprimées.
Exemples
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.textContent = `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.textContent = `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.
Spécifications
Spécification | Statut | Commentaire |
---|---|---|
Web Audio API La définition de 'AudioListener' dans cette spécification. |
Version de travail |
Compatibilité navigateurs
BCD tables only load in the browser