YARP
Yet Another Robot Platform
IAudioRender.h
Go to the documentation of this file.
1
/*
2
* Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3
* Copyright (C) 2006-2010 RobotCub Consortium
4
* All rights reserved.
5
*
6
* This software may be modified and distributed under the terms of the
7
* BSD-3-Clause license. See the accompanying LICENSE file for details.
8
*/
9
10
#ifndef YARP_DEV_IAUDIORENDER_H
11
#define YARP_DEV_IAUDIORENDER_H
12
13
#include <
yarp/sig/Sound.h
>
14
#include <
yarp/dev/api.h
>
15
#include <
yarp/dev/AudioBufferSize.h
>
16
17
namespace
yarp
{
18
namespace
dev {
19
20
class
YARP_dev_API
IAudioRender
21
{
22
public
:
26
virtual
~IAudioRender
();
27
34
virtual
bool
renderSound
(
const
yarp::sig::Sound
& sound) = 0;
35
41
virtual
bool
startPlayback
() = 0;
42
48
virtual
bool
stopPlayback
() = 0;
49
50
virtual
bool
getPlaybackAudioBufferMaxSize
(
yarp::dev::AudioBufferSize
& size) = 0;
51
52
virtual
bool
getPlaybackAudioBufferCurrentSize
(
yarp::dev::AudioBufferSize
& size) = 0;
53
54
virtual
bool
resetPlaybackAudioBuffer
() = 0;
55
};
56
57
}
// namespace dev
58
}
// namespace yarp
59
60
#endif // YARP_DEV_IAUDIORENDER_H
yarp::dev::IAudioRender::renderSound
virtual bool renderSound(const yarp::sig::Sound &sound)=0
Render a sound using a device (i.e.
yarp::dev::AudioBufferSize
Definition:
AudioBufferSize.h:26
yarp::dev::IAudioRender
Definition:
IAudioRender.h:21
yarp::dev::IAudioRender::getPlaybackAudioBufferMaxSize
virtual bool getPlaybackAudioBufferMaxSize(yarp::dev::AudioBufferSize &size)=0
yarp::dev::IAudioRender::getPlaybackAudioBufferCurrentSize
virtual bool getPlaybackAudioBufferCurrentSize(yarp::dev::AudioBufferSize &size)=0
yarp::dev::IAudioRender::~IAudioRender
virtual ~IAudioRender()
Destructor.
yarp::dev::IAudioRender::resetPlaybackAudioBuffer
virtual bool resetPlaybackAudioBuffer()=0
YARP_dev_API
#define YARP_dev_API
Definition:
api.h:19
yarp::dev::IAudioRender::startPlayback
virtual bool startPlayback()=0
Start the playback.
yarp::sig::Sound
Class for storing sounds.
Definition:
Sound.h:28
yarp
The main, catch-all namespace for YARP.
Definition:
environment.h:18
yarp::dev::IAudioRender::stopPlayback
virtual bool stopPlayback()=0
Stop the playback.
api.h
Sound.h
AudioBufferSize.h
YARP
3.4.100+20201223.2+gitb8ea4d712
src
libYARP_dev
src
yarp
dev
IAudioRender.h
Generated on Sun Jan 3 2021 02:46:23 for YARP by
1.8.20