YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | List of all members
yarp::dev::AudioPlayerStatus Class Reference

AudioPlayerStatus: A class used to describe the status of an audio player device. More...

#include <yarp/dev/AudioPlayerStatus.h>

+ Inheritance diagram for yarp::dev::AudioPlayerStatus:

Public Types

typedef yarp::os::idl::Unwrapped< AudioPlayerStatus > unwrapped
 

Public Member Functions

 AudioPlayerStatus ()=default
 
 AudioPlayerStatus (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. More...
 
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. More...
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
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
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

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

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. More...
 

Detailed Description

AudioPlayerStatus: A class used to describe the status of an audio player device.

See Audio in YARP for additional documentation on YARP audio.

Definition at line 27 of file AudioPlayerStatus.h.

Member Typedef Documentation

◆ unwrapped

typedef yarp::os::idl::Unwrapped<AudioPlayerStatus> yarp::dev::AudioPlayerStatus::unwrapped

Definition at line 69 of file AudioPlayerStatus.h.

Constructor & Destructor Documentation

◆ AudioPlayerStatus() [1/2]

yarp::dev::AudioPlayerStatus::AudioPlayerStatus ( )
default

◆ AudioPlayerStatus() [2/2]

yarp::dev::AudioPlayerStatus::AudioPlayerStatus ( const bool  enabled,
const size_t  current_buffer_size,
const size_t  max_buffer_size 
)

Definition at line 16 of file AudioPlayerStatus.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::AudioPlayerStatus::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::Portable.

Definition at line 45 of file AudioPlayerStatus.cpp.

◆ read() [2/2]

bool yarp::dev::AudioPlayerStatus::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

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

Definition at line 27 of file AudioPlayerStatus.cpp.

◆ toString()

std::string yarp::dev::AudioPlayerStatus::toString ( ) const

Definition at line 89 of file AudioPlayerStatus.cpp.

◆ write() [1/2]

bool yarp::dev::AudioPlayerStatus::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

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

Definition at line 58 of file AudioPlayerStatus.cpp.

◆ write() [2/2]

bool yarp::dev::AudioPlayerStatus::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
writeran 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 AudioPlayerStatus.cpp.

Member Data Documentation

◆ current_buffer_size

size_t yarp::dev::AudioPlayerStatus::current_buffer_size {0}

the size of the audio buffer [samples]

Definition at line 39 of file AudioPlayerStatus.h.

◆ enabled

bool yarp::dev::AudioPlayerStatus::enabled {false}

true if the playback is currently enabled

Definition at line 35 of file AudioPlayerStatus.h.

◆ max_buffer_size

size_t yarp::dev::AudioPlayerStatus::max_buffer_size {0}

the max_size of the audio buffer [samples]

Definition at line 43 of file AudioPlayerStatus.h.

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