A class that stores different boolean parameters for sound formats. More...

#include <omSoundFormatFlags.h>

Public Types
enum	Flag { UNDEFINED = 0, VBR = (1 << 0), DEFAULT = VBR }
	An enum that specifies the different sound format flags. More...

Public Member Functions
	SoundFormatFlags ()
	Create a new sound format flags object with no flags set. More...

	SoundFormatFlags (Flag flag)
	Create a new sound format flags object with the specified flag value initially set. More...

	SoundFormatFlags (UInt32 newFlags)
	Create a new sound format flags object with the specified initial combined flags value. More...

	operator UInt32 () const
	Convert this sound format flags object to an integer value. More...

Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...

void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that stores different boolean parameters for sound formats.

Member Enumeration Documentation

An enum that specifies the different sound format flags.

Enumerator
UNDEFINED	The flag value when all flags are not set.
VBR	A flag indicating that the sound should be encoded with a variable bitrate.
DEFAULT	The default flags to use for sound formats.

om::sound::base::SoundFormatFlags::SoundFormatFlags ( )

inline

Create a new sound format flags object with no flags set.

om::sound::base::SoundFormatFlags::SoundFormatFlags ( Flag flag )

inline

Create a new sound format flags object with the specified flag value initially set.

om::sound::base::SoundFormatFlags::SoundFormatFlags ( UInt32 newFlags )

inline

Create a new sound format flags object with the specified initial combined flags value.

om::sound::base::SoundFormatFlags::operator UInt32 ( ) const

inline

Convert this sound format flags object to an integer value.

This operator is provided so that the SoundFormatFlags object can be used as an integer value for bitwise logical operations.

Bool om::sound::base::SoundFormatFlags::isSet ( Flag flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::sound::base::SoundFormatFlags::set	(	Flag	flag,
		Bool	newIsSet
	)

inline

Set whether or not the specified flag value is set for this flags object.

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