Previous Topic Index Next Topic
[API function]

FSOUND_Sample_GetMode

Returns a bitfield containing information about the specified sample.
The values can be bitwise AND'ed with the values contained in FSOUND_MODES to see if certain criteria are true or not.
Information that can be retrieved from the same in this field are loop type, bitdepth and stereo/mono.

unsigned int F_API FSOUND_Sample_GetMode(
FSOUND_SAMPLE *sptr
);

Parameters

sptr Pointer to the sample to get the mode information on

Return Value

On success, the sample mode is returned.
On failure, 0 is returned.

Remarks

___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FSOUND_MODES , FSOUND_Sample_SetDefaults , FSOUND_Sample_SetDefaultsEx , FSOUND_Sample_SetMode , FSOUND_SetLoopMode

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