audio::CAudioTrack Class Reference
[Audio module, Nodes]
Audio track node.
More...
#include <AudioModule.h>
Inherits audio::CAudioBuffer.
Collaboration diagram for audio::CAudioTrack:
Public Member Functions | |
Creators | |
| CAudioTrack () | |
| Default constructor. | |
| CAudioTrack (fsf::CNode *pParent, fsf::Time tTime=0) | |
| 2-parameter constructor: parent and time stamp | |
| CAudioTrack (const std::string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 3-parameter constructor: node name, parent and time stamp | |
| CAudioTrack (unsigned int nNbChannels, unsigned int nFormat, unsigned int nNbFrames, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 5-parameter initialization constructor | |
| CAudioTrack (const std::string &strName, unsigned int nNbChannels, unsigned int nFormat, unsigned int nNbFrames, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 6-parameter initialization constructor | |
| CAudioTrack (const CAudioTrack &rhs) | |
| Copy constructor. | |
| virtual CNode * | clone () const |
| Cloning: necessary for run-time polymorphism. | |
Manipulators | |
| CAudioTrack & | operator= (const CAudioTrack &rhs) |
| Assignment operator. | |
| void | recordBuffer (CAudioBuffer *pBuffer) |
| Copies content of argument buffer at record index and advances record index. | |
| CAudioBuffer * | playBuffer (unsigned int nBufferFrames) |
| Copies content at play index into argument buffer and advances play index. | |
Accessors | |
| virtual void | getTypeID (std::string &str) const |
| Gets this node's factory mapping key. | |
| long | getRecordIndex () const |
| Gets record index position (no locking). | |
| long | getPlayIndex () const |
| Gets play index position (no locking). | |
Detailed Description
Audio track node.Constructor & Destructor Documentation
| audio::CAudioTrack::CAudioTrack | ( | ) | [inline] |
Default constructor.
| audio::CAudioTrack::CAudioTrack | ( | fsf::CNode * | pParent, | |
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
2-parameter constructor: parent and time stamp
| audio::CAudioTrack::CAudioTrack | ( | const std::string & | strName, | |
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
3-parameter constructor: node name, parent and time stamp
| CAudioTrack::CAudioTrack | ( | unsigned int | nNbChannels, | |
| unsigned int | nFormat, | |||
| unsigned int | nNbFrames, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) |
5-parameter initialization constructor
| CAudioTrack::CAudioTrack | ( | const std::string & | strName, | |
| unsigned int | nNbChannels, | |||
| unsigned int | nFormat, | |||
| unsigned int | nNbFrames, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) |
6-parameter initialization constructor
| CAudioTrack::CAudioTrack | ( | const CAudioTrack & | rhs | ) |
Copy constructor.
Member Function Documentation
| virtual CNode* audio::CAudioTrack::clone | ( | ) | const [inline, virtual] |
| long audio::CAudioTrack::getPlayIndex | ( | ) | const [inline] |
Gets play index position (no locking).
| long audio::CAudioTrack::getRecordIndex | ( | ) | const [inline] |
Gets record index position (no locking).
| virtual void audio::CAudioTrack::getTypeID | ( | std::string & | str | ) | const [inline, virtual] |
| CAudioTrack & CAudioTrack::operator= | ( | const CAudioTrack & | rhs | ) |
Assignment operator.
| CAudioBuffer * CAudioTrack::playBuffer | ( | unsigned int | nBufferFrames | ) |
Copies content at play index into argument buffer and advances play index.
| void CAudioTrack::recordBuffer | ( | CAudioBuffer * | pBuffer | ) |
Copies content of argument buffer at record index and advances record index.
The documentation for this class was generated from the following files:
