Platform SDK: DirectX

IDirectMusicPort::PlayBuffer

The IDirectMusicPort::PlayBuffer method is used to cue a buffer for playback by the port.

HRESULT PlayBuffer(
  IDIRECTMUSICBUFFER* pBuffer
);

Parameters

pBuffer
Address of a DirectMusicBuffer object to be added to the port's playback queue.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return one of the following error values:

E_FAIL
E_INVALIDARG
E_NOTIMPL
E_OUTOFMEMORY

Remarks

The buffer is in use by the system only for the duration of this method and can be reused after the method returns.

If no start time has been set by using the IDirectMusicBuffer::SetStartTime method, the start time is the time of the earliest event in the buffer, as set by the IDirectMusicBuffer::PackStructured or the IDirectMusicBuffer::PackUnstructured method.

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 dmusicc.h.

See Also

IDirectMusicBuffer, IDirectMusic::CreateMusicBuffer