DirectX SDK

IDirectMusicPerformance::GetPrepareTime

The IDirectMusicPerformance::GetPrepareTime method retrieves the amount of time ahead that IDirectMusicTrack::Play is called before the messages is heard through the speakers. This interval allows sufficient time for the message to be processed by tools.

HRESULT GetPrepareTime(
  DWORD* pdwMilliSeconds
);

Parameters

pdwMilliSeconds
Address of a variable to receive the amount of prepare time.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return E_POINTER.

Remarks

The default value is 1000 milliseconds.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.

See Also

IDirectMusicPerformance::SetPrepareTime, Timing