IXACTEngine::PrepareStreamingWave
IXACTEngine::PrepareStreamingWave
Creates a streaming wave object for the file handle that is passed in.
[Code-driven]
HRESULT PrepareStreamingWave( DWORD dwFlags, WAVEBANKENTRY entry, XACT_STREAMING_PARAMETERS streamingParams, DWORD dwAlignment, DWORD *pdwSeekTable, DWORD dwPlayOffset, XACTLOOPCOUNT nLoopCount, IXACTWave **ppWave );
Parameters
- dwFlags
Flags that affect wave preparation: - entry
WAVEBANKENTRY structure that describes the format, play region, and loop region for the wave. - streamingParams
XACT_STREAMING_PARAMETERS structure with a valid file handle, packet size, etc. - dwAlignment
Alignment of wave data on the media from which it is streamed. This must be at least 2048. Otherwise, it must be a multiple of 2048. - pdwSeekTable
The seek table for XMA content. The first DWORD must be the count of entries in the table that follows it. - 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
Loop count for the wave. - ppWave
Pointer an IXACTWave object that is returned.
Return Values
Returns S_OK if successful. Otherwise, an error code.
Remarks
If this API is used to prepare XMA content, the content must be encoded with 64K block size. ADPCM files are currently not supported.
Requirements
Header: Declared in Xact.h.
Library: Use Xact.lib.