YARP
Yet Another Robot Platform
yarp::dev::AudioBufferSize Class Reference

#include <yarp/dev/AudioBufferSize.h>

+ Inheritance diagram for yarp::dev::AudioBufferSize:

Public Member Functions

size_t getSamples ()
 
size_t getChannels ()
 
size_t getBufferElements ()
 
size_t getBytes ()
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool read (yarp::os::ConnectionReader &reader) override
 Read this object from a network connection. More...
 
bool write (yarp::os::ConnectionWriter &writer) const override
 Write this object to a network connection. More...
 
 AudioBufferSize ()
 
 AudioBufferSize (size_t samples, size_t channels, size_t depth_in_bytes)
 

Friends

template<typename SAMPLE >
class CircularAudioBuffer
 

Detailed Description

Definition at line 21 of file AudioBufferSize.h.

Constructor & Destructor Documentation

◆ AudioBufferSize() [1/2]

yarp::dev::AudioBufferSize::AudioBufferSize ( )
default

◆ AudioBufferSize() [2/2]

yarp::dev::AudioBufferSize::AudioBufferSize ( size_t  samples,
size_t  channels,
size_t  depth_in_bytes 
)

Definition at line 11 of file AudioBufferSize.cpp.

Member Function Documentation

◆ getBufferElements()

size_t yarp::dev::AudioBufferSize::getBufferElements ( )
inline

Definition at line 30 of file AudioBufferSize.h.

◆ getBytes()

size_t yarp::dev::AudioBufferSize::getBytes ( )
inline

Definition at line 31 of file AudioBufferSize.h.

◆ getChannels()

size_t yarp::dev::AudioBufferSize::getChannels ( )
inline

Definition at line 29 of file AudioBufferSize.h.

◆ getSamples()

size_t yarp::dev::AudioBufferSize::getSamples ( )
inline

Definition at line 28 of file AudioBufferSize.h.

◆ read() [1/2]

bool yarp::dev::AudioBufferSize::read ( yarp::os::ConnectionReader reader)
inlineoverridevirtual

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

Reimplemented from yarp::dev::audioBufferSizeData.

Definition at line 35 of file AudioBufferSize.h.

◆ read() [2/2]

bool yarp::dev::AudioBufferSize::read ( yarp::os::idl::WireReader reader)
inlineoverridevirtual

Reimplemented from yarp::dev::audioBufferSizeData.

Definition at line 33 of file AudioBufferSize.h.

◆ write() [1/2]

bool yarp::dev::AudioBufferSize::write ( const yarp::os::idl::WireWriter writer) const
inlineoverridevirtual

Reimplemented from yarp::dev::audioBufferSizeData.

Definition at line 34 of file AudioBufferSize.h.

◆ write() [2/2]

bool yarp::dev::AudioBufferSize::write ( yarp::os::ConnectionWriter writer) const
inlineoverridevirtual

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

Reimplemented from yarp::dev::audioBufferSizeData.

Definition at line 36 of file AudioBufferSize.h.

Friends And Related Function Documentation

◆ CircularAudioBuffer

template<typename SAMPLE >
friend class CircularAudioBuffer
friend

Definition at line 25 of file AudioBufferSize.h.


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