Previous Topic Index Next Topic
[API function]

FMUSIC_GetSample

Returns a pointer to a sample inside a module.
Once you have access to the module's sample, you can do a lot of things
to it, including locking and modifying the data within; using the
FSOUND_Sample_ functionality.

FSOUND_SAMPLE * F_API FMUSIC_GetSample(
FMUSIC_MODULE *mod,
int sampno
);

Parameters

mod Pointer to the song to retrieve a sample handle from
sampno index to sample inside module.

Return Value

On success, a valid sample handle is returned.
On failure, NULL is returned.

Remarks

Because of the instrument nature of some formats like XM, this
function lists all the samples in order of instruments and their subsamples.
ie if instrument 1 has 2 samples and instrument 2 contains 3 samples, then
sampno in this case would be 0 and 1 for instrument 1's samples, and 2,3 & 4
for instrument 2's samples.

See Also

FMUSIC_SetSample

This document copyright ©Firelight Multimedia, 1999-2001. All rights reserved.
Generated Thu Sep 13 00:18:08 2001 by SourceDoc v0.10, the automated source code documenter.