Share via


IXACTWaveBank::Play

IXACTWaveBank::Play

Starts the playback for a wave that is indicated by the wave index.

[Code-driven]

  HRESULT 
  Play(
  XACTINDEX nWaveIndex,
  DWORD dwFlags,
  DWORD dwPlayOffset,
  XACTLOOPCOUNT nLoopCount,
  IXACTWave **ppWave
);

Parameters

  • nWaveIndex
    Index of the wave.
  • dwFlags
    Flags that affect wave preparation:
  • dwPlayOffset
    Play offset to use as the start of the wave. The offset can be described in milliseconds or in samples. The dwFlags argument determines the offset units.
  • nLoopCount
    Number of loops for playback.
  • ppWave
    Pointer to an IXACTWave object that is returned.

Return Values

Returns S_OK if successful. Otherwise, an error code.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTWaveBank