[API function]
Adds a user synchronization callback point into a stream.
DLL_API int F_API FSOUND_Stream_AddSynchPoint(
FSOUND_STREAM *stream,
unsigned int pcmoffset,
const char *name
);
Parameters
stream |
The stream to add a synch point to.
|
pcmoffset |
Offset in SAMPLES (not bytes).
|
userdata |
The value to be passed in from the synch callback. This could be cast to a string or pointer.
|
Return Value
On success, a sync point index is returned.
On failure, -1 is returned.
Remarks
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_Stream_DeleteSynchPoint
,
FSOUND_Stream_GetNumSynchPoints
,
FSOUND_Stream_GetSynchPointInfo
,
FSOUND_Stream_SetSynchCallback
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.