This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

setVelocity

Summary

Sets the velocity vector of the listener. This vector controls both the direction of travel and the speed in 3D space. This velocity relative an audio source’s velocity is used to determine how much doppler shift (pitch change) to apply. The x, y, z parameters describe a direction vector indicating direction of travel and intensity. The default value is (0,0,0).

Method of apis/webaudio/AudioListenerapis/webaudio/AudioListener

Syntax

var  = AudioListener.setVelocity(x, y, z);

Parameters

x

Data-type
Number

y

Data-type
Number

z

Data-type
Number

Return Value

Returns an object of type NumberNumber

Examples

var audioCtx = new AudioContext();
var myListener = audioCtx.listener;
myListener.setVelocity(0,0,0);

Related specifications

Web Audio API
W3C Editor’s draft