audio::CAudioBuffer Class Reference
[Audio moduleNodes]

Audio buffer node. More...

#include <AudioModule.h>

Inherits fsf::CCharBuffer.

Inherited by audio::CAudioTrack.

Collaboration diagram for audio::CAudioBuffer:

Collaboration graph
[legend]

List of all members.

Public Member Functions

Creators
 CAudioBuffer ()
 Default constructor.
 CAudioBuffer (fsf::CNode *pParent, fsf::Time tTime=0)
 2-parameter constructor: parent and time stamp
 CAudioBuffer (const std::string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 3-parameter constructor: node name, parent and time stamp
 CAudioBuffer (unsigned int nNbChannels, unsigned int nFormat, unsigned int nNbFrames, long nBufferSize=-1, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 6-parameter initialization constructor
 CAudioBuffer (const std::string &strName, unsigned int nNbChannels, unsigned int nFormat, unsigned int nNbFrames, long nBufferSize=-1, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 7-parameter initialization constructor
 CAudioBuffer (const CAudioBuffer &rhs)
 Copy constructor.
virtual CNodeclone () const
 Cloning: necessary for run-time polymorphism.
Manipulators
CAudioBufferoperator= (const CAudioBuffer &rhs)
 Assignment operator.
Accessors
virtual void getTypeID (std::string &str) const
 Gets this node's factory mapping key.
unsigned int getNbChannels () const
 Gets this audio buffer's number of channels.
unsigned int getFormat () const
 Gets this audio buffer's audio format.
unsigned int getNbFrames () const
 Gets this audio buffer's number of frames.


Detailed Description

Audio buffer node.

Constructor & Destructor Documentation

audio::CAudioBuffer::CAudioBuffer (  )  [inline]

Default constructor.

audio::CAudioBuffer::CAudioBuffer ( fsf::CNode pParent,
fsf::Time  tTime = 0 
) [inline]

2-parameter constructor: parent and time stamp

audio::CAudioBuffer::CAudioBuffer ( const std::string &  strName,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
) [inline]

3-parameter constructor: node name, parent and time stamp

CAudioBuffer::CAudioBuffer ( unsigned int  nNbChannels,
unsigned int  nFormat,
unsigned int  nNbFrames,
long  nBufferSize = -1,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
)

6-parameter initialization constructor

CAudioBuffer::CAudioBuffer ( const std::string &  strName,
unsigned int  nNbChannels,
unsigned int  nFormat,
unsigned int  nNbFrames,
long  nBufferSize = -1,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
)

7-parameter initialization constructor

CAudioBuffer::CAudioBuffer ( const CAudioBuffer rhs  ) 

Copy constructor.


Member Function Documentation

virtual CNode* audio::CAudioBuffer::clone (  )  const [inline, virtual]

Cloning: necessary for run-time polymorphism.

Reimplemented from fsf::CCharBuffer.

Reimplemented in audio::CAudioTrack.

unsigned int audio::CAudioBuffer::getFormat (  )  const [inline]

Gets this audio buffer's audio format.

unsigned int audio::CAudioBuffer::getNbChannels (  )  const [inline]

Gets this audio buffer's number of channels.

unsigned int audio::CAudioBuffer::getNbFrames (  )  const [inline]

Gets this audio buffer's number of frames.

virtual void audio::CAudioBuffer::getTypeID ( std::string &  str  )  const [inline, virtual]

Gets this node's factory mapping key.

Reimplemented from fsf::CCharBuffer.

Reimplemented in audio::CAudioTrack.

CAudioBuffer & CAudioBuffer::operator= ( const CAudioBuffer rhs  ) 

Assignment operator.


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

Generated on Thu Oct 21 12:39:20 2010 for MFSM Modules by  doxygen 1.5.9