pdsp::ExternalInput Class Reference
Unit to copy values from an external audio input and convert them to a patchable output. More...
#include <ExternalInput.h>
Inheritance diagram for pdsp::ExternalInput:
Public Member Functions | |
| ExternalInput (const ExternalInput &other) | |
| void | copyInput (float *input, const int &bufferSize) noexcept |
| copies input from a non-interleaved array More... | |
| void | copyInterleavedInput (float *input, int index, int channels, const int &bufferSize) noexcept |
| copies input from a interleaved array More... | |
| Patchable & | out_signal () |
| Sets "signal" as selected output and return this Unit ready to be patched. This is the default output. This output contains the copied values, and if values have not been copied yet or the copy callback stopped it is set to a constant rate 0.0f. | |
 Public Member Functions inherited from pdsp::Unit | |
| Unit (const Unit &other) | |
| Unit & | operator= (const Unit &other) |
| Unit (Unit &&other) | |
| Unit & | operator= (Unit &&other) |
| virtual void | setOversampleLevel (int newOversampleLevel) |
| sets the unit oversample level More... | |
| int | getOversampleLevel () const |
| returns the Unit oversample level | |
| Public Member Functions inherited from pdsp::Patchable | |
| void | resetInputToDefault () |
| resets the selected input to the default. | |
| void | resetOutputToDefault () |
| resets the selected output to the default. | |
| Patchable & | in (const char *tag) |
| sets the selected input to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More... | |
| Patchable & | out (const char *tag) |
| sets the selected output to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More... | |
| void | disconnectIn () |
| disconnects all the outputs connected to the selected input, then resets the selected input to the default. | |
| void | disconnectOut () |
| disconnects all the inputs connected to the selected output, then resets the selected output to the default. | |
| void | disconnectAll () |
| disconnects all the inputs and outputs to their connected outputs and inputs. Also resets the selected input and output to the default. | |
| InputNode & | getSelectedInput () |
| returns the selected input, you can patch a Patchable or OutputNode to it with the >> operator. | |
| OutputNode & | getSelectedOutput () |
| returns the selected output, you can patch it to another Patchable or InputNode with the >> operator. | |
| std::vector< std::string > | getInputsList () |
| returns a vector of the valid input tags | |
| std::vector< std::string > | getOutputsList () |
| returns a vector of the valid input tags | |
Additional Inherited Members | |
| Static Public Member Functions inherited from pdsp::Preparable | |
| static double | getGlobalSampleRate () |
| Protected Member Functions inherited from pdsp::Unit | |
| void | prepareToPlay (int expectedBufferSize, double sampleRate) override |
| you have to use this method only in the constructor, inside if(dynamicConstruction){ } More... | |
| const float * | processInput (InputNode &node, int &stateNow) |
| process the given input, gives you a pointer to the processed buffer as result and its state More... | |
| float | processAndGetSingleValue (InputNode &input, int pos) |
| process the given input, gives you a pointer to the processed buffer as result and its state More... | |
| float * | getOutputBufferToFill (OutputNode &node) |
| gets a pointer to the output buffer for rendering audio to it, and sets the OutputNode state to AudioRate More... | |
| void | setControlRateOutput (OutputNode &node, float scalarValue) |
| sets the OutputNode buffer to "Changed" and its first value to scalarValue More... | |
| void | setOutputToZero (OutputNode &node) |
| sets the OutputNode buffer to "Changed" and its first value to 0.0f More... | |
| void | updateOutputNodes () |
| call this method in the Unit constructor after adding all the Outputs, this is mandatory for the inner working of the patching framework. | |
| Protected Member Functions inherited from pdsp::Patchable | |
| void | addOutput (const char *tag, OutputNode &output) |
| method to add outputs when constructing a Unit More... | |
| void | addInput (const char *tag, InputNode &input) |
| method to add inputs when constructing a Unit More... | |
| void | addModuleOutput (const char *tag, Patchable &unit) |
| method to add outputs when constructing a module More... | |
| void | addModuleInput (const char *tag, Patchable &unit) |
| method to add outputs when constructing a module More... | |
Detailed Description
Unit to copy values from an external audio input and convert them to a patchable output.
This class let you copy float values from an audio input callback and store them in an OutputNode ready to be patched.
Member Function Documentation
◆ copyInput()
|
noexcept |
copies input from a non-interleaved array
- Parameters
-
[in] input a pointer to the array to copy [in] bufferSize number of samples to copy
◆ copyInterleavedInput()
|
noexcept |
copies input from a interleaved array
- Parameters
-
[in] input a pointer to the array to copy [in] index index of the channel to copy [in] channels number of channels interleaved into the array [in] bufferSize number of samples to copy
The documentation for this class was generated from the following files:
- ExternalInput.h
- ExternalInput.cpp
