|
| FakeMicrophone () |
|
| FakeMicrophone (const FakeMicrophone &)=delete |
|
| FakeMicrophone (FakeMicrophone &&)=delete |
|
FakeMicrophone & | operator= (const FakeMicrophone &)=delete |
|
FakeMicrophone & | operator= (FakeMicrophone &&)=delete |
|
virtual | ~FakeMicrophone () override |
|
yarp::dev::ReturnValue | setHWGain (double gain) override |
| Sets the hardware gain of the grabbing device (if supported by the hardware)
|
|
bool | open (yarp::os::Searchable &config) override |
| Open the DeviceDriver.
|
|
bool | close () override |
| Close the DeviceDriver.
|
|
| DeviceDriver () |
|
| DeviceDriver (const DeviceDriver &other)=delete |
|
| DeviceDriver (DeviceDriver &&other) noexcept=delete |
|
DeviceDriver & | operator= (const DeviceDriver &other)=delete |
|
DeviceDriver & | operator= (DeviceDriver &&other) noexcept=delete |
|
virtual | ~DeviceDriver () |
|
virtual std::string | id () const |
| Return the id assigned to the PolyDriver.
|
|
virtual void | setId (const std::string &id) |
| Set the id for this device.
|
|
template<class T > |
bool | view (T *&x) |
| Get an interface to the device driver.
|
|
virtual DeviceDriver * | getImplementation () |
| Some drivers are bureaucrats, pointing at others.
|
|
virtual yarp::dev::ReturnValue | getSound (yarp::sig::Sound &sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s) override |
| Get a sound from a device.
|
|
virtual yarp::dev::ReturnValue | startRecording () override |
| Start the recording.
|
|
virtual yarp::dev::ReturnValue | stopRecording () override |
| Stop the recording.
|
|
virtual yarp::dev::ReturnValue | isRecording (bool &recording_enabled) override |
| Check if the recording has been enabled (e.g.
|
|
virtual yarp::dev::ReturnValue | getRecordingAudioBufferMaxSize (yarp::sig::AudioBufferSize &size) override |
|
virtual yarp::dev::ReturnValue | getRecordingAudioBufferCurrentSize (yarp::sig::AudioBufferSize &size) override |
|
virtual yarp::dev::ReturnValue | resetRecordingAudioBuffer () override |
|
virtual yarp::dev::ReturnValue | setSWGain (double gain) override |
| Sets a software gain for the grabbed audio.
|
|
virtual | ~AudioRecorderDeviceBase () |
|
virtual | ~IAudioGrabberSound () |
| Destructor.
|
|
| PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative) |
| Constructor.
|
|
| PeriodicThread (double period, PeriodicThreadClock clockAccuracy) |
| Constructor.
|
|
virtual | ~PeriodicThread () |
|
bool | start () |
| Call this to start the thread.
|
|
void | step () |
| Call this to "step" the thread rather than starting it.
|
|
void | stop () |
| Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).
|
|
void | askToStop () |
| Stop the thread.
|
|
bool | isRunning () const |
| Returns true when the thread is started, false otherwise.
|
|
bool | isSuspended () const |
| Returns true when the thread is suspended, false otherwise.
|
|
bool | setPeriod (double period) |
| Set the (new) period of the thread.
|
|
double | getPeriod () const |
| Return the current period of the thread.
|
|
void | suspend () |
| Suspend the thread, the thread keeps running by doLoop is never executed.
|
|
void | resume () |
| Resume the thread if previously suspended.
|
|
void | resetStat () |
| Reset thread statistics.
|
|
double | getEstimatedPeriod () const |
| Return estimated period since last reset.
|
|
void | getEstimatedPeriod (double &av, double &std) const |
| Return estimated period since last reset.
|
|
unsigned int | getIterations () const |
| Return the number of iterations performed since last reset.
|
|
double | getEstimatedUsed () const |
| Return the estimated duration of the run() function since last reset.
|
|
void | getEstimatedUsed (double &av, double &std) const |
| Return estimated duration of the run() function since last reset.
|
|
int | setPriority (int priority, int policy=-1) |
| Set the priority and scheduling policy of the thread, if the OS supports that.
|
|
int | getPriority () const |
| Query the current priority of the thread, if the OS supports that.
|
|
int | getPolicy () const |
| Query the current scheduling policy of the thread, if the OS supports that.
|
|
| FakeMicrophone_ParamsParser () |
|
| ~FakeMicrophone_ParamsParser () override=default |
|
bool | parseParams (const yarp::os::Searchable &config) override |
| Parse the DeviceDriver parameters.
|
|
std::string | getDeviceClassName () const override |
| Get the name of the DeviceDriver class.
|
|
std::string | getDeviceName () const override |
| Get the name of the device (i.e.
|
|
std::string | getDocumentationOfDeviceParams () const override |
| Get the documentation of the DeviceDriver's parameters.
|
|
std::vector< std::string > | getListOfParams () const override |
| Return a list of all params used by the device.
|
|
virtual | ~IDeviceDriverParams () |
|
fakeMicrophone
: fake microphone device implementing the IAudioGrabberSound interface to generate a test sound.
It can generate various signals, i.e. sine, sawtooth, square wave, constant. This device driver derives from AudioRecorderDeviceBase base class. Please check its documentation for additional details.
Parameters required by this device are shown in class: FakeMicrophone_ParamsParser This device also inherits some parameters from AudioRecorderDeviceBase
See Audio in YARP for additional documentation on YARP audio.
Definition at line 30 of file FakeMicrophone.h.