Microsoft DirectX 9.0 SDK Update (October 2004)

IDirectSound3DListener8::GetVelocity

The GetVelocity method retrieves the listener's velocity.

Syntax

HRESULT GetVelocity(
  D3DVECTOR * pvVelocity 
);

Parameters

pvVelocity

Address of a D3DVECTOR structure that receives the listener's velocity.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Remarks

Velocity is used only for calculating Doppler effect. It does not change the listener's position. To move the listener, use the IDirectSound3DListener8::SetPosition method.

The default velocity is (0,0,0).

Remarks

By default, measurement units are meters per second, but this can be changed by calling the IDirectSound3DListener8::SetDistanceFactor method.

Requirements

  Header: Dsound.h
  Library: Dsound3d.dll

See Also


© 2004 Microsoft Corporation. All rights reserved.