[API function]
Set a streams mode.
signed char F_API FSOUND_Stream_SetMode(
FSOUND_STREAM *stream,
unsigned int mode
);
Parameters
| stream |
Pointer to the stream to have the mode set.
|
| mode |
The mode bits to set from FSOUND_MODES.
|
Return Value
On success, TRUE is returned.
On failure, FALSE is returned.
Remarks
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.
Only the following modes are accepted, others will be filtered out.
FSOUND_LOOP_BIDI, FSOUND_LOOP_NORMAL, FSOUND_LOOP_OFF, FSOUND_2D. FSOUND_LOOP_BIDI is treated as FSOUND_LOOP_NORMAL. FSOUND_2D is accepted only if the sound is not hardware.
On Playstation 2, XBox and GameCube, FSOUND_HW2D and FSOUND_HW3D are supported, so you can change between them at runtime.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube
See Also
FSOUND_MODES
,
FSOUND_Stream_GetMode
This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:36 2005
by SourceDoc v0.10, the automated source code documenter.
