Share via

IXACTSoundBank::Prepare

  • Article

IXACTSoundBank::Prepare

Prepares a cue instance for playback.

[Content-driven]

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

Parameters

  • nCueIndex
    [in] Value that indicates the index of the cue to be prepared.
  • dwFlags
    [in] Unused. Should be 0.
  • timeOffset
    [in] Time offset into the cue to start from, in milliseconds.
  • ppCue
    [out] Pointer to the IXACTCue object that is returned.

Return Values

Returns S_OK if successful. Otherwise, an error code.

Remarks

This method returns a valid cue instance that is ready to be played. All allocations and stream priming, if necessary, are performed by this method.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTSoundBank