om::engine::sound::SoundDeviceBus Class Reference

A class that represents a arbitrary group of sound device channels that are multiplexed into a sound stream. More...

#include <omEngineSoundDeviceBus.h>

Public Types
enum	Type { INPUT = 1, OUTPUT = 2 }
	An enum type which represents the different types of sound device bus. More...

Public Member Functions
	SoundDeviceBus ()
	Create a sound device bus that an undefined channel layout and no device assigned. More...
	~SoundDeviceBus ()
	Destroy this sound device bus and its internal data. More...
const UTF8String &	getDeviceName () const
	Return the name of the device associated with this device bus. More...
void	setDeviceName (const UTF8String &newDeviceName)
	Set the name of the device associated with this device bus. More...
Type	getType () const
	Return the type of this sound device bus. More...
void	setType (Type newType)
	Set the type of this sound device bus. More...
Size	getChannelCount () const
	Return the number of channels there are in this device bus. More...
Index	getChannelIndex (Index layoutIndex) const
	Return the device channel index that is assigned to the specified channel index in the channel layout. More...
void	setChannelIndex (Index layoutIndex, Index deviceIndex)
	Set the device channel index that is assigned to the specified channel index in the channel layout. More...
const ChannelLayout &	getLayout () const
	Return a reference to the channel layout for this device bus. More...
void	setLayout (const ChannelLayout &newLayout)
	Set the channel layout that this device bus should use. More...
void	setChannelCount (Size newNumChannels)
	Set the number of channels that this device bus should use. More...

Static Public Attributes
static const om::resources::ResourceType	RESOURCE_TYPE
	The resource type for a sound device bus. More...

Detailed Description

A class that represents a arbitrary group of sound device channels that are multiplexed into a sound stream.

Member Enumeration Documentation

enum om::engine::sound::SoundDeviceBus::Type

An enum type which represents the different types of sound device bus.

Enumerator
INPUT	A sound device bus type that represents a group of input device channels.
OUTPUT	A sound device bus type that represents a group of output device channels.

Constructor & Destructor Documentation

om::engine::sound::SoundDeviceBus::SoundDeviceBus

(

)

Create a sound device bus that an undefined channel layout and no device assigned.

om::engine::sound::SoundDeviceBus::~SoundDeviceBus

(

)

Destroy this sound device bus and its internal data.

Member Function Documentation

const UTF8String& om::engine::sound::SoundDeviceBus::getDeviceName ( ) const

inline

Return the name of the device associated with this device bus.

void om::engine::sound::SoundDeviceBus::setDeviceName ( const UTF8String &  newDeviceName )

inline

Set the name of the device associated with this device bus.

Type om::engine::sound::SoundDeviceBus::getType ( ) const

inline

Return the type of this sound device bus.

void om::engine::sound::SoundDeviceBus::setType ( Type  newType )

inline

Set the type of this sound device bus.

Size om::engine::sound::SoundDeviceBus::getChannelCount ( ) const

inline

Return the number of channels there are in this device bus.

Index om::engine::sound::SoundDeviceBus::getChannelIndex ( Index  layoutIndex ) const

inline

Return the device channel index that is assigned to the specified channel index in the channel layout.

void om::engine::sound::SoundDeviceBus::setChannelIndex ( Index  layoutIndex, Index  deviceIndex  )

inline

Set the device channel index that is assigned to the specified channel index in the channel layout.

const ChannelLayout& om::engine::sound::SoundDeviceBus::getLayout ( ) const

inline

Return a reference to the channel layout for this device bus.

void om::engine::sound::SoundDeviceBus::setLayout

(

const ChannelLayout &

newLayout

)

Set the channel layout that this device bus should use.

If the new layout has more channels than the previous layout, the new channels are populated with increasing device channel indices.

void om::engine::sound::SoundDeviceBus::setChannelCount

(

Size

newNumChannels

)

Set the number of channels that this device bus should use.

A custom channel layout with the specified number of channels is used. If the new layout has more channels than the previous layout, the new channels are populated with increasing device channel indices.

Member Data Documentation

const om::resources::ResourceType om::engine::sound::SoundDeviceBus::RESOURCE_TYPE

static

The resource type for a sound device bus.

---

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

• omEngineSoundDeviceBus.h