Previous Topic Index Next Topic
[API function]

FSOUND_Stream_CreateDSP

Allows the user to add a custom DSP unit to a stream.

FSOUND_DSPUNIT *F_API FSOUND_Stream_CreateDSP(
FSOUND_STREAM *stream,
FSOUND_DSPCALLBACK callback,
int priority,
void *userdata
);

Parameters

stream The stream pointer to have a DSP attached to.
callback A standard FSOUND_DSPCALLBACK function callback pointer.
priority The priority, or position within the streams DSP chain to place the unit.
param A user parameter that gets passed back into the DSP callback.

Return Value

On success, a handle to the FSOUND_DSPUNIT is returned. All DSP functions are performable on this.
On failure, 0 is returned.

Remarks

The priority for a stream DSP unit is not related to the priorities specified in fmod.h.
The priorities are anything fom 0 onwards, and ALWAYS come after data is read/decoded for the stream.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, GameCube

See Also

FSOUND_DSP_Create , FSOUND_DSPCALLBACK

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:35 2005 by SourceDoc v0.10, the automated source code documenter.