CL_StaticSoundProvider3
Static soundprovider class.
Overview
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.