Previous Topic Index Next Topic
[API function]

FSOUND_Sample_Lock

Returns a pointer to the beginning of the sample data for a sample.
Data written to these pointers must be signed.

signed char F_API FSOUND_Sample_Lock(
FSOUND_SAMPLE *sptr,
int offset,
int length,
void **ptr1,
void **ptr2,
unsigned int *len1,
unsigned int *len2
);

Parameters

sptr Pointer to the sample definition.
offset Offset in BYTES to the position you want to lock in the sample buffer.
length Number of BYTES you want to lock in the sample buffer.
ptr1 Address of a pointer that will point to the first part of the locked data.
ptr2 Address of a pointer that will point to the second part of the locked data.
This will be NULL if the data locked hasnt wrapped at the end of the buffer.
len1 Length of data in BYTES that was locked for ptr1
len2 Length of data in BYTES that was locked for ptr2.
This will be 0 if the data locked hasnt wrapped at the end of the buffer.

Return Value

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

Remarks

You must unlock the data again after you have finished with it, using FSOUND_Sample_Unlock.
Data written to these pointers must be signed.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox

See Also

FSOUND_Sample_Alloc , FSOUND_Sample_Unlock , FSOUND_Sample_Upload

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Dec 20 16:31:09 2002 by SourceDoc v0.10, the automated source code documenter.