IAudioGrabberSound.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_DEV_IAUDIOGRABBERSOUND_H
#define YARP_DEV_IAUDIOGRABBERSOUND_H
 
#include <yarp/dev/api.h>
#include <yarp/dev/ReturnValue.h>
#include <yarp/sig/AudioBufferSize.h>
#include <yarp/sig/Sound.h>
 
namespace yarp::dev {
 
class YARP_dev_API IAudioGrabberSound
{
public:
    virtual ~IAudioGrabberSound();
 
    virtual yarp::dev::ReturnValue getSound(yarp::sig::Sound& sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s) = 0;
 
    virtual yarp::dev::ReturnValue startRecording() = 0;
 
    virtual yarp::dev::ReturnValue stopRecording() = 0;
 
    virtual yarp::dev::ReturnValue isRecording(bool& recording_enabled) = 0;
 
    virtual yarp::dev::ReturnValue getRecordingAudioBufferMaxSize(yarp::sig::AudioBufferSize& size) = 0;
 
    virtual yarp::dev::ReturnValue getRecordingAudioBufferCurrentSize(yarp::sig::AudioBufferSize& size) = 0;
 
    virtual yarp::dev::ReturnValue resetRecordingAudioBuffer() = 0;
 
    virtual yarp::dev::ReturnValue setSWGain(double gain) = 0;
 
    virtual yarp::dev::ReturnValue setHWGain(double gain) = 0;
};
 
} // namespace yarp::dev
 
#endif // YARP_DEV_IAUDIOGRABBERSOUND_H