Share via

IXACTSoundBank::Play

  • Article

IXACTSoundBank::Play

Plays a cue. Optionally, returns an instance handle to the cue object for further control.

[Content-driven]

  HRESULT 
  Play(
  XACTINDEX nCueIndex,
  DWORD dwFlags,
  XACTTIME timeOffset,
  IXACTCue **ppCue
);

Parameters

  • nCueIndex
    [in] Value that indicates the index of the cue to be played.
  • dwFlags
    [in] Flags to pass to IXACTSoundBank::Prepare for cue playback.
  • timeOffset
    [in] Time offset into the cue to start from, in milliseconds.
  • ppCue
    [out, optional] Pointer to the IXACTCue object that is returned. If NULL is specified, no cue instance object 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

IXACTSoundBank