NAME
CL_Sample - ClanLib's datafile samples. This class can read samples from datafiles.
CLASS MEMBERS
- static CL_SoundBuffer *create(
-
const char *sample_id, CL_InputSourceProvider *provider)
- CL_Sample(
-
const char *s_id, CL_InputSourceProvider *_provider)
- virtual ~CL_Sample()
- virtual void lock()
- virtual void unlock()
- virtual SoundFormat get_format()
- virtual int data_size()
- virtual void *get_data()
- virtual int get_frequency()
MEMBERS WITH DESCRIPTIONS
- static CL_SoundBuffer *create(
-
const char *sample_id, CL_InputSourceProvider *provider)
Description:
Loads the sample sample_id from the inputsource provider provider. Creates a CL_SoundBuffer using this sample and returns it.
- CL_Sample(
-
const char *s_id, CL_InputSourceProvider *_provider)
Description:
Constructs a static sound provider that represents sample_id from theinputsource provider provider.
- virtual ~CL_Sample()
-
Description:
- virtual void lock()
-
Description:
Locks the sample data.
- virtual void unlock()
-
Description:
Unlocks the sample data.
- virtual SoundFormat get_format()
-
Description:
Returns the sample format used by this sample.
- virtual int data_size()
-
Description:
Returns the size of the sample.
- virtual void *get_data()
-
Description:
Returns the sample data. Must be locked before this is done.
- virtual int get_frequency()
-
Description:
Returns the default frequency used when playing this sample.
SEE ALSO
All ClanLib API classes can be found in clanlib (3).
AUTHORS
Originally written by Magnus Norddahl <[email protected]> and Martin Starch <[email protected]>. ClanLib is now developed by the ClanLib Development team as an Open Source project.
The ClanLib man pages was created using the Perceps documentation system (another excellent piece of Open Source software, available at http://somewhere.in.the.world.org).
See clanlib (3) to find out how to get a full list of contributors and details on how to submit bug reports, comments etc.