YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IAudioRender.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef YARP_DEV_IAUDIORENDER_H
8#define YARP_DEV_IAUDIORENDER_H
9
10#include <yarp/sig/Sound.h>
11#include <yarp/dev/api.h>
14
15namespace yarp::dev {
16
80
81} // namespace yarp::dev
82
83#endif // YARP_DEV_IAUDIORENDER_H
Interface for rendering a YARP-format sound and controlling its reproduction ona device.
virtual yarp::dev::ReturnValue getPlaybackAudioBufferCurrentSize(yarp::sig::AudioBufferSize &size)=0
virtual ~IAudioRender()
Destructor.
virtual yarp::dev::ReturnValue startPlayback()=0
Start the playback.
virtual yarp::dev::ReturnValue renderSound(const yarp::sig::Sound &sound)=0
Render a sound using a device (i.e.
virtual yarp::dev::ReturnValue stopPlayback()=0
Stop the playback.
virtual yarp::dev::ReturnValue setHWGain(double gain)=0
Sets the hardware gain of the playback device (if supported by the hardware)
virtual yarp::dev::ReturnValue isPlaying(bool &playback_enabled)=0
Check if the playback has been enabled (e.g.
virtual yarp::dev::ReturnValue setSWGain(double gain)=0
Sets a software gain for the played audio.
virtual yarp::dev::ReturnValue getPlaybackAudioBufferMaxSize(yarp::sig::AudioBufferSize &size)=0
virtual yarp::dev::ReturnValue resetPlaybackAudioBuffer()=0
Class for storing sounds See Audio in YARP for additional documentation on YARP audio.
Definition Sound.h:25
For streams capable of holding different kinds of content, check what they actually have.
#define YARP_dev_API
Definition api.h:18