Microsoft DirectX 8.1 (C++)

IDirectSound3DBuffer8::GetVelocity

The GetVelocity method retrieves the velocity for this sound buffer. Velocity is measured in units per second. The default unit is one meter, but this can be changed by using the IDirectSound3DListener8::SetDistanceFactor method.

Syntax

HRESULT GetVelocity(
  D3DVECTOR * pvVelocity 
);

Parameters

pvVelocity

Address of a D3DVECTOR structure that receives the sound buffer'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 for Doppler effects only. It does not actually move the buffer. For more information, see Doppler Factor.

The default unit of measurement is meters per second, but this can be changed by using the IDirectSound3DListener8::SetDistanceFactor method.

Requirements

  Header: Declared in dsound.h.

See Also