yarp::sig::AudioRecorderStatus Class Reference

AudioRecorderStatus: A class used to describe the status of an audio recorder device. More...

#include <idl_generated_code/yarp/sig/AudioRecorderStatus.h>

Inheritance diagram for yarp::sig::AudioRecorderStatus:

Public Types
typedef yarp::os::idl::Unwrapped< AudioRecorderStatus >	unwrapped

Public Member Functions
	AudioRecorderStatus ()=default
	AudioRecorderStatus (const bool enabled, const size_t current_buffer_size, const size_t max_buffer_size)
bool	read (yarp::os::idl::WireReader &reader) override
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
bool	write (const yarp::os::idl::WireWriter &writer) const override
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
std::string	toString () const
Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool	readBare (yarp::os::ConnectionReader &reader)
virtual bool	writeBare (yarp::os::ConnectionWriter &writer) const
virtual bool	readBottle (yarp::os::ConnectionReader &reader)
virtual bool	writeBottle (yarp::os::ConnectionWriter &writer) const
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
bool	enabled {false}
	true if the playback is currently enabled
size_t	current_buffer_size {0}
	the size of the audio buffer [samples]
size_t	max_buffer_size {0}
	the max_size of the audio buffer [samples]

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

AudioRecorderStatus: A class used to describe the status of an audio recorder device.

See Audio in YARP for additional documentation on YARP audio.

Definition at line 27 of file AudioRecorderStatus.h.

Member Typedef Documentation

unwrapped

typedef yarp::os::idl::Unwrapped<AudioRecorderStatus> yarp::sig::AudioRecorderStatus::unwrapped

Definition at line 69 of file AudioRecorderStatus.h.

Constructor & Destructor Documentation

AudioRecorderStatus() [1/2]

yarp::sig::AudioRecorderStatus::AudioRecorderStatus ( )

default

AudioRecorderStatus() [2/2]

yarp::sig::AudioRecorderStatus::AudioRecorderStatus	(	const bool	enabled,
		const size_t	current_buffer_size,
		const size_t	max_buffer_size
	)

Definition at line 16 of file AudioRecorderStatus.cpp.

Member Function Documentation

read() [1/2]

bool yarp::sig::AudioRecorderStatus::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 45 of file AudioRecorderStatus.cpp.

read() [2/2]

bool yarp::sig::AudioRecorderStatus::read ( yarp::os::idl::WireReader &  reader )

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 27 of file AudioRecorderStatus.cpp.

toString()

std::string yarp::sig::AudioRecorderStatus::toString

(

)

const

Definition at line 89 of file AudioRecorderStatus.cpp.

write() [1/2]

bool yarp::sig::AudioRecorderStatus::write ( const yarp::os::idl::WireWriter &  writer ) const

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 58 of file AudioRecorderStatus.cpp.

write() [2/2]

bool yarp::sig::AudioRecorderStatus::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 76 of file AudioRecorderStatus.cpp.

Member Data Documentation

current_buffer_size

size_t yarp::sig::AudioRecorderStatus::current_buffer_size {0}

the size of the audio buffer [samples]

Definition at line 39 of file AudioRecorderStatus.h.

enabled

bool yarp::sig::AudioRecorderStatus::enabled {false}

true if the playback is currently enabled

Definition at line 35 of file AudioRecorderStatus.h.

max_buffer_size

size_t yarp::sig::AudioRecorderStatus::max_buffer_size {0}

the max_size of the audio buffer [samples]

Definition at line 43 of file AudioRecorderStatus.h.

---

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

• src/libYARP_sig/src/idl_generated_code/yarp/sig/AudioRecorderStatus.h
• src/libYARP_sig/src/idl_generated_code/yarp/sig/AudioRecorderStatus.cpp