rtaudiom::CInputInterface Class Reference
[RtAudio module, Nodes]
Audio input interface node.
More...
#include <RtAudioModule.h>
Inherits fsf::CNode.
Collaboration diagram for rtaudiom::CInputInterface:
Public Member Functions | |
Creators | |
| CInputInterface () | |
| Default constructor. | |
| CInputInterface (fsf::CNode *pParent, fsf::Time tTime=0) | |
| 2-parameter constructor: parent and time stamp | |
| CInputInterface (const std::string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 3-parameter constructor: node name, parent and time stamp | |
| CInputInterface (const CInputInterface &rhs) | |
| Copy constructor. | |
| virtual | ~CInputInterface () |
| Virtual destructor. | |
| virtual fsf::CNode * | clone () const |
| Cloning: necessary for tun-rime polymorphism. | |
Manipulators | |
| CInputInterface & | operator= (const CInputInterface &rhs) |
| Assignment operator. | |
| void | setReceiveCell (CReceive *pCell) |
| Sets the pointer to the audio receive cell. | |
| bool | open (int nInputDevice, int nInputChannels, unsigned int nFormat, unsigned int nSampleRate, unsigned int nBufferSize) |
| Opens an input stream with specified parameters. | |
| bool | close () |
| Closes the input stream. | |
Accessors | |
| virtual void | getTypeID (std::string &str) const |
| Gets this cell's factory mapping key. | |
Detailed Description
Audio input interface node.Encapsulates RtAudio API
Constructor & Destructor Documentation
| CInputInterface::CInputInterface | ( | ) |
Default constructor.
| CInputInterface::CInputInterface | ( | fsf::CNode * | pParent, | |
| fsf::Time | tTime = 0 | |||
| ) |
2-parameter constructor: parent and time stamp
| CInputInterface::CInputInterface | ( | const std::string & | strName, | |
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) |
3-parameter constructor: node name, parent and time stamp
| CInputInterface::CInputInterface | ( | const CInputInterface & | rhs | ) |
Copy constructor.
| CInputInterface::~CInputInterface | ( | ) | [virtual] |
Virtual destructor.
Member Function Documentation
| virtual fsf::CNode* rtaudiom::CInputInterface::clone | ( | ) | const [inline, virtual] |
| bool CInputInterface::close | ( | ) |
Closes the input stream.
| virtual void rtaudiom::CInputInterface::getTypeID | ( | std::string & | str | ) | const [inline, virtual] |
| bool CInputInterface::open | ( | int | nInputDevice, | |
| int | nInputChannels, | |||
| unsigned int | nFormat, | |||
| unsigned int | nSampleRate, | |||
| unsigned int | nBufferSize | |||
| ) |
Opens an input stream with specified parameters.
| CInputInterface & CInputInterface::operator= | ( | const CInputInterface & | rhs | ) |
Assignment operator.
| void rtaudiom::CInputInterface::setReceiveCell | ( | CReceive * | pCell | ) | [inline] |
Sets the pointer to the audio receive cell.
The documentation for this class was generated from the following files:
