IDirectSound3DListener::SetVelocity

The IDirectSound3DListener::SetVelocity method sets the listener's velocity.

HRESULT SetVelocity(
  D3DVALUE x,    
  D3DVALUE y,    
  D3DVALUE z,    
  DWORD dwApply  
);
 

Parameters

x, y, and z

Values whose types are D3DVALUE and that represent the coordinates of the listener's new velocity vector.

dwApply

Value indicating when the setting should be applied. This value must be one of the following:

DS3D_DEFERRED	Settings are not applied until the application calls the IDirectSound3DListener::CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.
DS3D_IMMEDIATE	Settings are applied immediately, causing the system to recalculate the 3-D coordinates for all 3-D sound buffers.

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::GetVelocity