IXACTSoundBank::Play

Plays a cue, optionally returning an instance handle to the cue object for further control.

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

Parameters

nCueIndex

[in] Value indicating the index of the cue to be played.

dwFlags

[in] Flags to pass to IXACTSoundBank::Prepare for cue playback.

timeOffset

[in] Offset from the beginning of the sound in ms to start play from.

ppCue

[out, optional] Pointer to the IXACTCue object returned. If NULL is specified, no cue instance object is returned.

Note    If nCueIndex refers to an interactive queue this parameter is not optional and can not be NULL.

Return Values

Returns S_OK if successful or an error code otherwise.

Requirements

Header: Declared in Xact.h.

See Also

IXACTSoundBank