YARP
Yet Another Robot Platform
IAudioGrabberSound.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_IAUDIOGRABBERSOUND_H
11
#define YARP_DEV_IAUDIOGRABBERSOUND_H
12
13
#include <
yarp/dev/api.h
>
14
#include <
yarp/dev/AudioBufferSize.h
>
15
#include <
yarp/sig/Sound.h
>
16
17
namespace
yarp
{
18
namespace
dev {
19
25
class
YARP_dev_API
IAudioGrabberSound
26
{
27
public
:
31
virtual
~IAudioGrabberSound
();
32
45
virtual
bool
getSound
(
yarp::sig::Sound
& sound,
size_t
min_number_of_samples,
size_t
max_number_of_samples,
double
max_samples_timeout_s) = 0;
46
52
virtual
bool
startRecording
() = 0;
53
59
virtual
bool
stopRecording
() = 0;
60
61
virtual
bool
getRecordingAudioBufferMaxSize
(
yarp::dev::AudioBufferSize
& size) = 0;
62
63
virtual
bool
getRecordingAudioBufferCurrentSize
(
yarp::dev::AudioBufferSize
& size) = 0;
64
65
virtual
bool
resetRecordingAudioBuffer
() = 0;
66
};
67
68
}
// namespace dev
69
}
// namespace yarp
70
71
#endif // YARP_DEV_IAUDIOGRABBERSOUND_H
yarp::dev::AudioBufferSize
Definition:
AudioBufferSize.h:26
yarp::dev::IAudioGrabberSound::getRecordingAudioBufferMaxSize
virtual bool getRecordingAudioBufferMaxSize(yarp::dev::AudioBufferSize &size)=0
yarp::dev::IAudioGrabberSound::startRecording
virtual bool startRecording()=0
Start the recording.
yarp::dev::IAudioGrabberSound::~IAudioGrabberSound
virtual ~IAudioGrabberSound()
Destructor.
yarp::dev::IAudioGrabberSound
Read a YARP-format sound block from a device.
Definition:
IAudioGrabberSound.h:26
yarp::dev::IAudioGrabberSound::getRecordingAudioBufferCurrentSize
virtual bool getRecordingAudioBufferCurrentSize(yarp::dev::AudioBufferSize &size)=0
yarp::dev::IAudioGrabberSound::resetRecordingAudioBuffer
virtual bool resetRecordingAudioBuffer()=0
YARP_dev_API
#define YARP_dev_API
Definition:
api.h:19
yarp::sig::Sound
Class for storing sounds.
Definition:
Sound.h:28
yarp::dev::IAudioGrabberSound::getSound
virtual bool getSound(yarp::sig::Sound &sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s)=0
Get a sound from a device.
yarp
The main, catch-all namespace for YARP.
Definition:
environment.h:18
yarp::dev::IAudioGrabberSound::stopRecording
virtual bool stopRecording()=0
Stop the recording.
api.h
Sound.h
AudioBufferSize.h
YARP
3.4.100+20201223.2+gitb8ea4d712
src
libYARP_dev
src
yarp
dev
IAudioGrabberSound.h
Generated on Sun Jan 3 2021 02:46:23 for YARP by
1.8.20