Previous Topic Index Next Topic
[API function]

FSOUND_Stream_AddSyncPoint

Adds a user synchronization callback point into a stream.

DLL_API FSOUND_SYNCPOINT * F_API FSOUND_Stream_AddSyncPoint(
FSOUND_STREAM *stream,
unsigned int pcmoffset,
const char *name
);

Parameters

stream The stream to add a sync point to.
pcmoffset Offset in SAMPLES (not bytes).
name The name of the syncpoint, which will be passed into the sync callback when it is triggered.

Return Value

On success, a sync point handle is returned.
On failure, NULL 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_DeleteSyncPoint , FSOUND_Stream_GetNumSyncPoints , FSOUND_Stream_GetSyncPoint , FSOUND_Stream_GetSyncPointInfo , FSOUND_Stream_SetSyncCallback

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.