om::sound::base::SoundFormatSettings Class Reference

A class that specifies common settings for sound formats. More...

#include <omSoundFormatSettings.h>

Public Member Functions
	SoundFormatSettings ()
	Create a default sound format settings object. More...
SoundFormatFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the sound format setting. More...
const SoundFormatFlags &	getFlags () const
	Return an object that contains boolean parameters of the sound format setting. More...
void	setFlags (const SoundFormatFlags &newFlags)
	Set an object that contains boolean parameters of the sound format setting. More...
Bool	flagIsSet (SoundFormatFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this sound format setting. More...
Bool	flagsAreSet (const SoundFormatFlags &otherFlags) const
	Return whether or not all of the specified boolan flags are set for this sound format setting. More...
void	setFlag (SoundFormatFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this sound format setting. More...
const SampleType &	getSampleType () const
	Return the type that is used for sound samples in this format. More...
void	setSampleType (const SampleType &newSampleType)
	Set the type that is used for sound samples in this format. More...
Float	getBitRate () const
	Return the target bitrate in kilobits/second for encoding sound. More...
void	setBitRate (Float newBitRate)
	Set the target bitrate in kilobits/second for encoding sound. More...
Float	getMinBitRate () const
	Return the minimum allowed bitrate in kilobits/second for encoding sound with a variable bitrate. More...
void	setMinBitRate (Float newMinBitRate)
	Set the minimum allowed bitrate in kilobits/second for encoding sound with a variable bitrate. More...
Float	getMaxBitRate () const
	Return the maximum allowed bitrate in kilobits/second for encoding sound with a variable bitrate. More...
void	setMaxBitRate (Float newMaxBitRate)
	Set the maximum allowed bitrate in kilobits/second for encoding sound with a variable bitrate. More...

Detailed Description

A class that specifies common settings for sound formats.

Constructor & Destructor Documentation

om::sound::base::SoundFormatSettings::SoundFormatSettings ( )

inline

Create a default sound format settings object.

Member Function Documentation

SoundFormatFlags& om::sound::base::SoundFormatSettings::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the sound format setting.

const SoundFormatFlags& om::sound::base::SoundFormatSettings::getFlags ( ) const

inline

Return an object that contains boolean parameters of the sound format setting.

void om::sound::base::SoundFormatSettings::setFlags ( const SoundFormatFlags &  newFlags )

inline

Set an object that contains boolean parameters of the sound format setting.

Bool om::sound::base::SoundFormatSettings::flagIsSet ( SoundFormatFlags::Flag  flag ) const

inline

Return whether or not the specified boolan flag is set for this sound format setting.

Bool om::sound::base::SoundFormatSettings::flagsAreSet ( const SoundFormatFlags &  otherFlags ) const

inline

Return whether or not all of the specified boolan flags are set for this sound format setting.

void om::sound::base::SoundFormatSettings::setFlag ( SoundFormatFlags::Flag  flag, Bool  newIsSet = true  )

inline

Set whether or not the specified boolan flag is set for this sound format setting.

const SampleType& om::sound::base::SoundFormatSettings::getSampleType ( ) const

inline

Return the type that is used for sound samples in this format.

void om::sound::base::SoundFormatSettings::setSampleType ( const SampleType &  newSampleType )

inline

Set the type that is used for sound samples in this format.

Float om::sound::base::SoundFormatSettings::getBitRate ( ) const

inline

Return the target bitrate in kilobits/second for encoding sound.

void om::sound::base::SoundFormatSettings::setBitRate ( Float  newBitRate )

inline

Set the target bitrate in kilobits/second for encoding sound.

The bit rate is clamped to be in the range [0,+infinity].

Float om::sound::base::SoundFormatSettings::getMinBitRate ( ) const

inline

Return the minimum allowed bitrate in kilobits/second for encoding sound with a variable bitrate.

void om::sound::base::SoundFormatSettings::setMinBitRate ( Float  newMinBitRate )

inline

Set the minimum allowed bitrate in kilobits/second for encoding sound with a variable bitrate.

The bit rate is clamped to be in the range [0,+infinity].

Float om::sound::base::SoundFormatSettings::getMaxBitRate ( ) const

inline

Return the maximum allowed bitrate in kilobits/second for encoding sound with a variable bitrate.

void om::sound::base::SoundFormatSettings::setMaxBitRate ( Float  newMaxBitRate )

inline

Set the maximum allowed bitrate in kilobits/second for encoding sound with a variable bitrate.

The bit rate is clamped to be in the range [0,+infinity].

---

The documentation for this class was generated from the following file:

• omSoundFormatSettings.h