FSOUND_Stream_SetSynchCallback

##### [API function]

## FSOUND_Stream_SetSynchCallback

Sets a callback function for when a stream passes over a WAV tag/marker. These are markers that
a sound editing program such as Sound Forge can drop into the actual wave data. FMOD will
trigger callbacks with these markers when the stream plays, and pass in the string through the callback that the marker contains.

signed char F_API FSOUND_Stream_SetSynchCallback(
FSOUND_STREAM *stream,
FSOUND_STREAMCALLBACK callback,
int userdata
);

### Parameters

stream | Pointer to the stream to callback when a synch point is reached.
callback | Function to call when synch point is reached.
userdata | user data that is passed into the callback.

### Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

### Remarks

Note it uses a FSOUND_STREAMCALLBACK function callback. This is normally for user streams but for
the sake of re-usability this prototype is used. 'buff' is a null terminated string provided by
the marker. 'len' is the offset in samples that the marker was set at.
The return value can be TRUE or FALSE, it is ignored.
-----------
Note you can save a WAV out using an MP3 wav codec (and then just rename the WAV to MP3 if you like) to get
synch marker support for compressed MP3 files. FMOD will pick up on this and read the markers out.
-----------
WMA/ASF/Internet streaming do not support this function.
--------------
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_MODES , FSOUND_Stream_AddSynchPoint , FSOUND_Stream_DeleteSynchPoint , FSOUND_Stream_GetNumSynchPoints , FSOUND_Stream_GetSynchPointInfo , FSOUND_Stream_Play , FSOUND_STREAMCALLBACK

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Jul 11 16:00:55 2003 by SourceDoc v0.10, the automated source code documenter.