SoundDataBase

Scaleform::Sound

Scaleform::Sound::SoundDataBase

Declaration

class SoundDataBase : public RefCountBaseNTS<SoundDataBase,Stat_Sound_Mem>;

Description

SoundDataBase is a base class describing the basic parameters of sound data in GFx. This class does not hold any sound data nor does it provide a pointer to the sound data, as its derived classes can hold only a file name of a file with sound data. SoundDataBase acts as the base class for SoundData.

Enumerations

Enumeration	Description
SampleFormat	Collection of sound data format flags.

Methods

Method	Description
GetChannelNumber	Retrieves the number of sound channels used in the sound data.
GetDuration	Obtains the duration of time for which a sample sound data plays.
GetFormat	Returns the format of the sample sound data.
GetRate	Returns the sample rate of the sound data.
GetRawSize	Returns the size of the sound data in bytes.
GetSampleCount	Obtains the number of samples in the sound data.
GetSampleSize	Returns the size of one sample in the sound data in bytes.
GetSeekSample	Obtains the number of samples that are skipped when the sample starts playing.
IsDataCompressed	Determines whether the sound data is in compressed/ uncompressed format.
IsFileSample	Determines whether the sound data comes from a file.
IsStreamSample	Determines if the sound data should be used in the streaming mode.
SetSeekSample	Sets the number of samples that should be skipped when sample starts playing.
SoundDataBase	Constructs a sound data object.

File

Sound_Sound.h