PortAudioPlayerDeviceDriver_ParamsParser Class Reference

This class is the parameters parser for class PortAudioPlayerDeviceDriver. More...

#include <portaudioPlayer/PortAudioPlayerDeviceDriver_ParamsParser.h>

Inheritance diagram for PortAudioPlayerDeviceDriver_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	PortAudioPlayerDeviceDriver_ParamsParser ()
	~PortAudioPlayerDeviceDriver_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.
bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.
std::string	getConfiguration () const override
	Return the configuration of the device.
Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Public Attributes
const std::string	m_device_classname = {"PortAudioPlayerDeviceDriver"}
const std::string	m_device_name = {"portaudioPlayer"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_audio_device_id_defaultValue = {"-1"}
const std::string	m_driver_frame_size_defaultValue = {"512"}
int	m_audio_device_id = {-1}
size_t	m_driver_frame_size = {512}

Detailed Description

This class is the parameters parser for class PortAudioPlayerDeviceDriver.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	audio_device_id	int	-	-1	0	The device id, if multiple sound cards are present	if not specified, the default system device will be used
-	driver_frame_size	size_t	samples	512	0	the number of samples to process on each iteration of the main thread	-

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device portaudioPlayer --audio_device_id -1 --driver_frame_size 512

yarpdev --device portaudioPlayer

Definition at line 42 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

Constructor & Destructor Documentation

PortAudioPlayerDeviceDriver_ParamsParser()

PortAudioPlayerDeviceDriver_ParamsParser::PortAudioPlayerDeviceDriver_ParamsParser

(

)

Definition at line 23 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

~PortAudioPlayerDeviceDriver_ParamsParser()

PortAudioPlayerDeviceDriver_ParamsParser::~PortAudioPlayerDeviceDriver_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string PortAudioPlayerDeviceDriver_ParamsParser::getConfiguration ( ) const

overridevirtual

Return the configuration of the device.

Returns

The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 56 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

getDeviceClassName()

std::string PortAudioPlayerDeviceDriver_ParamsParser::getDeviceClassName ( ) const

inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns

A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 68 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

getDeviceName()

std::string PortAudioPlayerDeviceDriver_ParamsParser::getDeviceName ( ) const

inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns

A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 69 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string PortAudioPlayerDeviceDriver_ParamsParser::getDocumentationOfDeviceParams ( ) const

overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns

A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 133 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > PortAudioPlayerDeviceDriver_ParamsParser::getListOfParams ( ) const

overridevirtual

Return a list of all params used by the device.

Returns

A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

getParamValue()

bool PortAudioPlayerDeviceDriver_ParamsParser::getParamValue ( const std::string &  paramName, std::string &  paramValue  ) const

overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns

True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 37 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

parseParams()

bool PortAudioPlayerDeviceDriver_ParamsParser::parseParams ( const yarp::os::Searchable &  config )

overridevirtual

Parse the DeviceDriver parameters.

Returns

true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 66 of file PortAudioPlayerDeviceDriver_ParamsParser.cpp.

Member Data Documentation

m_audio_device_id

int PortAudioPlayerDeviceDriver_ParamsParser::m_audio_device_id = {-1}

Definition at line 64 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_audio_device_id_defaultValue

const std::string PortAudioPlayerDeviceDriver_ParamsParser::m_audio_device_id_defaultValue = {"-1"}

Definition at line 61 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_device_classname

const std::string PortAudioPlayerDeviceDriver_ParamsParser::m_device_classname = {"PortAudioPlayerDeviceDriver"}

Definition at line 49 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_device_name

const std::string PortAudioPlayerDeviceDriver_ParamsParser::m_device_name = {"portaudioPlayer"}

Definition at line 50 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_driver_frame_size

size_t PortAudioPlayerDeviceDriver_ParamsParser::m_driver_frame_size = {512}

Definition at line 65 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_driver_frame_size_defaultValue

const std::string PortAudioPlayerDeviceDriver_ParamsParser::m_driver_frame_size_defaultValue = {"512"}

Definition at line 62 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_parser_is_strict

bool PortAudioPlayerDeviceDriver_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_parser_version

const parser_version_type PortAudioPlayerDeviceDriver_ParamsParser::m_parser_version = {}

Definition at line 57 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

m_provided_configuration

std::string PortAudioPlayerDeviceDriver_ParamsParser::m_provided_configuration

Definition at line 59 of file PortAudioPlayerDeviceDriver_ParamsParser.h.

---

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

• src/devices/portaudioPlayer/PortAudioPlayerDeviceDriver_ParamsParser.h
• src/devices/portaudioPlayer/PortAudioPlayerDeviceDriver_ParamsParser.cpp