documentation/3.0.0/SoundRecorder_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Audio/Export.hpp>


#include <SFML/Audio/SoundChannel.hpp>


#include <memory>

#include <string>

#include <vector>


#include <cstddef>

#include <cstdint>


namespace sf

{


class SFML_AUDIO_API SoundRecorder

{

public:

    virtual ~SoundRecorder();


    [[nodiscard]] bool start(unsigned int sampleRate = 44100);


    void stop();


    [[nodiscard]] unsigned int getSampleRate() const;


    [[nodiscard]] static std::vector<std::string> getAvailableDevices();


    [[nodiscard]] static std::string getDefaultDevice();


    [[nodiscard]] bool setDevice(const std::string& name);


    [[nodiscard]] const std::string& getDevice() const;


    void setChannelCount(unsigned int channelCount);


    [[nodiscard]] unsigned int getChannelCount() const;


    [[nodiscard]] const std::vector<SoundChannel>& getChannelMap() const;


    [[nodiscard]] static bool isAvailable();


protected:

    SoundRecorder();


    virtual bool onStart();


    [[nodiscard]] virtual bool onProcessSamples(const std::int16_t* samples, std::size_t sampleCount) = 0;


    virtual void onStop();


private:

    // Member data

    struct Impl;

    const std::unique_ptr<Impl> m_impl;

};


} // namespace sf


Export.hpp

SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42

SoundChannel.hpp

sf::SoundRecorder::getDevice
const std::string & getDevice() const
Get the name of the current audio capture device.

sf::SoundRecorder::getChannelMap
const std::vector< SoundChannel > & getChannelMap() const
Get the map of position in sample frame to sound channel.

sf::SoundRecorder::getAvailableDevices
static std::vector< std::string > getAvailableDevices()
Get a list of the names of all available audio capture devices.

sf::SoundRecorder::SoundRecorder
SoundRecorder()
Default constructor.

sf::SoundRecorder::getChannelCount
unsigned int getChannelCount() const
Get the number of channels used by this recorder.

sf::SoundRecorder::start
bool start(unsigned int sampleRate=44100)
Start the capture.

sf::SoundRecorder::onStart
virtual bool onStart()
Start capturing audio data.

sf::SoundRecorder::stop
void stop()
Stop the capture.

sf::SoundRecorder::setDevice
bool setDevice(const std::string &name)
Set the audio capture device.

sf::SoundRecorder::isAvailable
static bool isAvailable()
Check if the system supports audio capture.

sf::SoundRecorder::onProcessSamples
virtual bool onProcessSamples(const std::int16_t *samples, std::size_t sampleCount)=0
Process a new chunk of recorded samples.

sf::SoundRecorder::~SoundRecorder
virtual ~SoundRecorder()
destructor

sf::SoundRecorder::getDefaultDevice
static std::string getDefaultDevice()
Get the name of the default audio capture device.

sf::SoundRecorder::setChannelCount
void setChannelCount(unsigned int channelCount)
Set the channel count of the audio capture device.

sf::SoundRecorder::getSampleRate
unsigned int getSampleRate() const
Get the sample rate.

sf::SoundRecorder::onStop
virtual void onStop()
Stop capturing audio data.

sf
Definition AudioResource.hpp:36