NAME
CL_StaticSoundProvider - Static Soundprovider class.
DESCRIPTION
The static soundprovider provides the data for any static (non-streamed) samples played using the ClanLib sound system.
CLASS MEMBERS
- virtual ~CL_StaticSoundProvider()
- 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
- virtual ~CL_StaticSoundProvider()
-
Description:
- virtual void lock()
-
Description:
Locks the soundprovider. Locking a provider means, that the contents of the provider should be available following the call to lock(), which means that lock loads any files from disk, and performs any necessary initializations.
- virtual void unlock()
-
Description:
Unlocks the soundprovider. Unlocking a provider means, that the contents of the provider should be deinitialized, thus removing any loaded sample data from memory.
- virtual SoundFormat get_format()
-
Description:
Returns the soundformat of the data stored by the provider. The data stored can be either 8-bit signed, 8-bit unsigned, 16-bit signed and 16-bit unsigned.
Return value:
The soundformat of the data stored.
- virtual int data_size()
-
Description:
Returns the total size in bytes of the data stored.
Return value:
Size of data stored (in bytes).
- virtual void *get_data()
-
Description:
Returns a pointer to the data stored.
Return value:
A pointer to the data stored.
- virtual int get_frequency()
-
Description:
Returns the frequency of the data stored.
Return value:
Frequency of data stored.
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.