A Jack audio input component. More...
#include <mipjackinput.h>
Inheritance diagram for MIPJackInput:
Collaboration diagram for MIPJackInput:
Public Member Functions | |
| bool | open (MIPTime interval=MIPTime(0.020), const std::string &serverName=std::string(""), MIPTime arrayTime=MIPTime(10.0)) |
| Opens the connection with the Jack server. | |
| int | getSamplingRate () const |
| Returns the sampling rate used for outgoing messages. | |
| bool | close () |
| Closes the connection with the Jack server. | |
Detailed Description
This component can be used to capture audio using the Jack audio connection kit. The component only accepts MIPSYSTEMMESSAGE_TYPE_WAITTIME messages and it produces floating point stereo raw audio messages.
- Note:
- A frame consists of a number of samples (equal to the number of channels) sampled at the same instant. For example, in a stereo sound file, one frame would consist of two samples: one for the left channel and one for the right.
Member Function Documentation
| bool MIPJackInput::close | ( | ) |
| int MIPJackInput::getSamplingRate | ( | ) | const [inline] |
| bool MIPJackInput::open | ( | MIPTime | interval = MIPTime(0.020), |
| const std::string & | serverName = std::string(""), |
||
| MIPTime | arrayTime = MIPTime(10.0) |
||
| ) |
This function initializes the component.
- Parameters:
-
interval The amount of audio frames read during each iteration, expressed as a time interval serverName The name of the Jack server to connect to arrayTime Size of the internal buffer used to temporarily store audio in, expressed as a time interval. Note that this is not the amount of delay introduced by the component.
The documentation for this class was generated from the following file:
- src/components/input/mipjackinput.h
