IDirectSound3DListener::GetVelocity

The IDirectSound3DListener::GetVelocity method retrieves the listener's current velocity.

HRESULT GetVelocity(
  LPD3DVECTOR lpvVelocity  
);
 

Parameters

lpvVelocity

Address of a D3DVECTOR structure that will contain the listener's current 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 Doppler effects. It does not actually move the listener. To change the listener's position, use the IDirectSound3DListener::SetPosition method. The default velocity is (0,0,0).

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSound3DListener::SetVelocity