YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
AudioRecorder_nws_yarp Class Reference
Devices » Device Implementations » YARP Network Wrapper Servers (NWS)

AudioRecorder_nws_yarp: A Wrapper which streams audio over the network, after grabbing it from a device. More...

#include <networkWrappers/audioRecorder_nws_yarp/AudioRecorder_nws_yarp.h>

+ Inheritance diagram for AudioRecorder_nws_yarp:

Public Member Functions

 AudioRecorder_nws_yarp ()
 Constructor.
 
 AudioRecorder_nws_yarp (const AudioRecorder_nws_yarp &)=delete
 
 AudioRecorder_nws_yarp (AudioRecorder_nws_yarp &&)=delete
 
AudioRecorder_nws_yarp & operator= (const AudioRecorder_nws_yarp &)=delete
 
AudioRecorder_nws_yarp & operator= (AudioRecorder_nws_yarp &&)=delete
 
 ~AudioRecorder_nws_yarp () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool attach (yarp::dev::PolyDriver *driver) override
 Attach to another object.
 
bool detach () override
 Detach the object (you must have first called attach).
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
- Public Member Functions inherited from yarp::dev::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.
 
- Public Member Functions inherited from yarp::dev::WrapperSingle
 ~WrapperSingle () override
 Destructor.
 
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects.
 
bool detachAll () final
 Detach the object (you must have first called attach).
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor.
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from AudioRecorder_nws_yarp_ParamsParser
 AudioRecorder_nws_yarp_ParamsParser ()
 
 ~AudioRecorder_nws_yarp_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.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Friends

class AudioRecorderStatusThread
 
class AudioRecorderDataThread
 

Additional Inherited Members

- Public Attributes inherited from AudioRecorder_nws_yarp_ParamsParser
const std::string m_device_classname = {"AudioRecorder_nws_yarp"}
 
const std::string m_device_name = {"audioRecorder_nws_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_name_defaultValue = {"/audioRecorder_nws"}
 
const std::string m_period_defaultValue = {"0.02"}
 
const std::string m_debug_defaultValue = {"false"}
 
const std::string m_min_samples_over_network_defaultValue = {"11250"}
 
const std::string m_max_samples_over_network_defaultValue = {"11250"}
 
const std::string m_getSound_timeout_defaultValue = {"1.0"}
 
const std::string m_start_defaultValue = {"false"}
 
const std::string m_send_sound_on_stop_defaultValue = {"true"}
 
std::string m_name = {"/audioRecorder_nws"}
 
float m_period = {0.02}
 
bool m_debug = {false}
 
size_t m_min_samples_over_network = {11250}
 
size_t m_max_samples_over_network = {11250}
 
float m_getSound_timeout = {1.0}
 
bool m_start = {false}
 
bool m_send_sound_on_stop = {true}
 

Detailed Description

AudioRecorder_nws_yarp: A Wrapper which streams audio over the network, after grabbing it from a device.

Description of input parameters

Parameters required by this device are shown in class: AudioRecorder_nws_yarp_ParamsParser

See Audio in YARP for additional documentation on YARP audio.

Definition at line 42 of file AudioRecorder_nws_yarp.h.

Constructor & Destructor Documentation

◆ AudioRecorder_nws_yarp() [1/3]

AudioRecorder_nws_yarp::AudioRecorder_nws_yarp ( )

Constructor.

Definition at line 18 of file AudioRecorder_nws_yarp.cpp.

◆ AudioRecorder_nws_yarp() [2/3]

AudioRecorder_nws_yarp::AudioRecorder_nws_yarp ( const AudioRecorder_nws_yarp &  )
delete

◆ AudioRecorder_nws_yarp() [3/3]

AudioRecorder_nws_yarp::AudioRecorder_nws_yarp ( AudioRecorder_nws_yarp &&  )
delete

◆ ~AudioRecorder_nws_yarp()

AudioRecorder_nws_yarp::~AudioRecorder_nws_yarp ( )
override

Definition at line 23 of file AudioRecorder_nws_yarp.cpp.

Member Function Documentation

◆ attach()

bool AudioRecorder_nws_yarp::attach ( yarp::dev::PolyDriver *  driver)
overridevirtual

Attach to another object.

Parameters
driverthe polydriver that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 95 of file AudioRecorder_nws_yarp.cpp.

◆ close()

bool AudioRecorder_nws_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 60 of file AudioRecorder_nws_yarp.cpp.

◆ detach()

bool AudioRecorder_nws_yarp::detach ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 126 of file AudioRecorder_nws_yarp.cpp.

◆ open()

bool AudioRecorder_nws_yarp::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 28 of file AudioRecorder_nws_yarp.cpp.

◆ operator=() [1/2]

AudioRecorder_nws_yarp & AudioRecorder_nws_yarp::operator= ( AudioRecorder_nws_yarp &&  )
delete

◆ operator=() [2/2]

AudioRecorder_nws_yarp & AudioRecorder_nws_yarp::operator= ( const AudioRecorder_nws_yarp &  )
delete

◆ read()

bool AudioRecorder_nws_yarp::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 84 of file AudioRecorder_nws_yarp.cpp.

Friends And Related Symbol Documentation

◆ AudioRecorderDataThread

friend class AudioRecorderDataThread
friend

Definition at line 88 of file AudioRecorder_nws_yarp.h.

◆ AudioRecorderStatusThread

friend class AudioRecorderStatusThread
friend

Definition at line 87 of file AudioRecorder_nws_yarp.h.

The documentation for this class was generated from the following files: