YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarpAudioPlayer_IDL Class Reference

yarpAudioPlayer_IDL Interface. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarpAudioPlayer/idl_generated_code/yarpAudioPlayer_IDL.h>

+ Inheritance diagram for yarpAudioPlayer_IDL:

Public Member Functions

virtual yarp::os::ApplicationNetworkProtocolVersion getLocalProtocolVersion ()
 
virtual yarp::os::ApplicationNetworkProtocolVersion getRemoteProtocolVersion ()
 
virtual bool checkProtocolVersion ()
 
 yarpAudioPlayer_IDL ()
 
virtual bool play (const std::string &filename)
 Play the given audio file.
 
virtual bool test (const std::string &type="sine", const double duration=1, const double frequency=440, const std::int16_t amplitude=30000, const std::int16_t sampling_rate=16000, const std::int16_t channels=1)
 Generate and send a test sound.
 
virtual std::vector< std::string > help (const std::string &functionName="--all")
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
- Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLink & yarp ()
 Get YARP state associated with this object.
 
const yarp::os::WireLink & yarp () const
 Get YARP state associated with this object (const version).
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 

Detailed Description

yarpAudioPlayer_IDL Interface.

Definition at line 22 of file yarpAudioPlayer_IDL.h.

Constructor & Destructor Documentation

◆ yarpAudioPlayer_IDL()

yarpAudioPlayer_IDL::yarpAudioPlayer_IDL ( )

Definition at line 590 of file yarpAudioPlayer_IDL.cpp.

Member Function Documentation

◆ checkProtocolVersion()

bool yarpAudioPlayer_IDL::checkProtocolVersion ( )
virtual

Definition at line 80 of file yarpAudioPlayer_IDL.cpp.

◆ getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpAudioPlayer_IDL::getLocalProtocolVersion ( )
virtual

Definition at line 95 of file yarpAudioPlayer_IDL.cpp.

◆ getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpAudioPlayer_IDL::getRemoteProtocolVersion ( )
virtual

Definition at line 65 of file yarpAudioPlayer_IDL.cpp.

◆ help()

std::vector< std::string > yarpAudioPlayer_IDL::help ( const std::string &  functionName = "--all")
virtual

Definition at line 616 of file yarpAudioPlayer_IDL.cpp.

◆ play()

bool yarpAudioPlayer_IDL::play ( const std::string &  filename)
virtual

Play the given audio file.

Returns
true/false on success/failure

Reimplemented in PlayerModule.

Definition at line 595 of file yarpAudioPlayer_IDL.cpp.

◆ read()

bool yarpAudioPlayer_IDL::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::PortReader.

Definition at line 648 of file yarpAudioPlayer_IDL.cpp.

◆ test()

bool yarpAudioPlayer_IDL::test ( const std::string &  type = "sine",
const double  duration = 1,
const double  frequency = 440,
const std::int16_t  amplitude = 30000,
const std::int16_t  sampling_rate = 16000,
const std::int16_t  channels = 1 
)
virtual

Generate and send a test sound.

Parameters
typecan be "sine" , "sawtooth" , "squarewave"
durationthe duration of the sound in seconds
frequencythe signal in hertz
amplitudethe amplitude of the signal (16 bit)
channelsnumber of channels
sampling_ratesignal sampling rate (samples/s)
Returns
true/false on success/failure

Reimplemented in PlayerModule.

Definition at line 605 of file yarpAudioPlayer_IDL.cpp.


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