Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Attributes | List of all members
om::engine::sound::SoundBus Class Reference

A class that represents a set of sound inputs and outputs for a module. More...

#include <omEngineSoundBus.h>

Public Member Functions

 SoundBus ()
 Create a new unnamed sound bus with 1 stream. More...
 
const UTF8String & getName () const
 Return a reference to the name of this sound bus. More...
 
void setName (const UTF8String &newName)
 Set the name of this sound bus. More...
 
Size getStreamCount () const
 Return the number of input and output streams there are in this sound bus. More...
 
void setStreamCount (Size newStreamCount)
 Set the number of input and output streams there are in this sound bus. More...
 

Static Public Attributes

static const ResourceType RESOURCE_TYPE
 The resource type for a sound bus. More...
 

Detailed Description

A class that represents a set of sound inputs and outputs for a module.

Constructor & Destructor Documentation

om::engine::sound::SoundBus::SoundBus ( )
inline

Create a new unnamed sound bus with 1 stream.

Member Function Documentation

const UTF8String& om::engine::sound::SoundBus::getName ( ) const
inline

Return a reference to the name of this sound bus.

void om::engine::sound::SoundBus::setName ( const UTF8String &  newName)
inline

Set the name of this sound bus.

Size om::engine::sound::SoundBus::getStreamCount ( ) const
inline

Return the number of input and output streams there are in this sound bus.

void om::engine::sound::SoundBus::setStreamCount ( Size  newStreamCount)
inline

Set the number of input and output streams there are in this sound bus.

Member Data Documentation

const ResourceType om::engine::sound::SoundBus::RESOURCE_TYPE
static

The resource type for a sound bus.


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