#include <ringbufferinput.h>
|
typedef OrderedMap< SinkBase > | InputMap |
|
typedef OrderedMap< SourceBase > | OutputMap |
|
DescriptionMap | inputDescription |
|
DescriptionMap | outputDescription |
|
DescriptionMap | parameterDescription |
|
DescriptionMap | parameterRange |
|
void | declareInput (SinkBase &sink, const std::string &name, const std::string &desc) |
|
void | declareInput (SinkBase &sink, int n, const std::string &name, const std::string &desc) |
|
void | declareInput (SinkBase &sink, int acquireSize, int releaseSize, const std::string &name, const std::string &desc) |
|
void | declareOutput (SourceBase &source, const std::string &name, const std::string &desc) |
|
void | declareOutput (SourceBase &source, int n, const std::string &name, const std::string &desc) |
|
void | declareOutput (SourceBase &source, int acquireSize, int releaseSize, const std::string &name, const std::string &desc) |
|
void | declareParameter (const std::string &name, const std::string &desc, const std::string &range, const Parameter &defaultValue) |
|
◆ RingBufferInput()
◆ ~RingBufferInput()
◆ add()
void add |
( |
Real * |
inputData, |
|
|
int |
size |
|
) |
| |
◆ configure()
This function will be automatically called after some parameters have been set. This is the place where you should write your specific code which needs to be called when configuring this object.
You can access the newly set parameters using the parameter()
method.
Reimplemented from Configurable.
◆ declareParameters()
void declareParameters |
( |
| ) |
|
|
inlinevirtual |
Declare the parameters that this Configurable
can accept. You have to implement this method in derived classes, even though you don't need any parameters. In that case, just define it as empty.
In this method you should only be calling the declareParameter
method, once for each parameter, with optional default values.
Implements Configurable.
References Configurable::declareParameter().
◆ process()
◆ reset()
This function will be called when doing batch computations between each file that is processed. That is, if your algorithm is some sort of state machine, it allows you to reset it to its original state to process another file without having to delete and reinstantiate it. This function should not be called directly. Use resetNetwork instead to reset a network of connected Algorithms.
Reimplemented from Algorithm.
◆ shouldStop()
void shouldStop |
( |
bool |
stop | ) |
|
|
inlinevirtual |
Sets whether an algorithm should stop as soon as it has finished processing all of its inputs. This is most often called when the algorithm has received an STOP_WHEN_DONE signal (at the end of the stream).
Reimplemented from Algorithm.
References E_DEBUG, and essentia::EExecution.
◆ _impl
◆ _output
◆ category
◆ description
◆ name
The documentation for this class was generated from the following file: