Mp3SoundConverter Class Reference

sound_compression_mp3: A portmonitor which is able to convert apply mp3 compression/decompression to yarp::sig::Sound data transmitted over the network. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/portmonitors/sound_compression_mp3/Mp3Sound.h>

Inheritance diagram for Mp3SoundConverter:

Public Member Functions
bool	create (const yarp::os::Property &options) override
	This will be called when the dll is properly loaded by the portmonitor carrier.
void	destroy () override
	This will be called when the portmonitor object destroyes.
bool	setparam (const yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are set via YARP admin port.
bool	getparam (yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are requested via YARP admin port.
bool	accept (yarp::os::Things &thing) override
	This will be called when the data reach the portmonitor object.
yarp::os::Things &	update (yarp::os::Things &thing) override
	After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified.
Public Member Functions inherited from yarp::os::MonitorObject
virtual	~MonitorObject ()
virtual void	trig ()
	This will be called when one of the peer connections to the same import port receives data.
virtual yarp::os::Things &	updateReply (yarp::os::Things &thing)
	The updateReply makes it possible to modify a reply from a port when the portmonitor object is attached to a two-ways connection (e.g., RPC).

Detailed Description

sound_compression_mp3: A portmonitor which is able to convert apply mp3 compression/decompression to yarp::sig::Sound data transmitted over the network.

Example usage: yarp connect /src /dest tcp+recv.portmonitor+type.dll+file.sound_compression_mp3

See Audio in YARP for additional documentation on YARP audio.

Definition at line 24 of file Mp3Sound.h.

Member Function Documentation

accept()

bool Mp3SoundConverter::accept ( yarp::os::Things &  thing )

overridevirtual

This will be called when the data reach the portmonitor object.

Parameters

thing

An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns

returning false will avoid delivering data to an input port or transmitting through the output port

Reimplemented from yarp::os::MonitorObject.

Definition at line 46 of file Mp3Sound.cpp.

create()

bool Mp3SoundConverter::create ( const yarp::os::Property &  options )

overridevirtual

This will be called when the dll is properly loaded by the portmonitor carrier.

Parameters

options

A set of useful information of the current connection which the monitor object is attached.

Returns

Returning false will stop the portmonitor object to procced

Reimplemented from yarp::os::MonitorObject.

Definition at line 26 of file Mp3Sound.cpp.

destroy()

void Mp3SoundConverter::destroy ( void  )

overridevirtual

This will be called when the portmonitor object destroyes.

Reimplemented from yarp::os::MonitorObject.

Definition at line 32 of file Mp3Sound.cpp.

getparam()

bool Mp3SoundConverter::getparam ( yarp::os::Property &  params )

overridevirtual

This will be called when the portmonitor carrier parameters are requested via YARP admin port.

Parameters

params

The Property

Returns

Returns true of any parameter is available

Reimplemented from yarp::os::MonitorObject.

Definition at line 41 of file Mp3Sound.cpp.

setparam()

bool Mp3SoundConverter::setparam ( const yarp::os::Property &  params )

overridevirtual

This will be called when the portmonitor carrier parameters are set via YARP admin port.

Parameters

params

The Property

Returns

Returns true if parameters are correctly set

Reimplemented from yarp::os::MonitorObject.

Definition at line 36 of file Mp3Sound.cpp.

update()

yarp::os::Things & Mp3SoundConverter::update ( yarp::os::Things &  thing )

overridevirtual

After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified.

Parameters

thing

An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns

An instance of modified data in form of Thing

Reimplemented from yarp::os::MonitorObject.

Definition at line 65 of file Mp3Sound.cpp.

---

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

• src/portmonitors/sound_compression_mp3/Mp3Sound.h
• src/portmonitors/sound_compression_mp3/Mp3Sound.cpp