documentation/3.0.0/Sound_8hpp_source

//

// 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/SoundSource.hpp>


#include <memory>


#include <cstdlib>


namespace sf

{

class Time;

class SoundBuffer;


class SFML_AUDIO_API Sound : public SoundSource

{

public:

    explicit Sound(const SoundBuffer& buffer);


    Sound(const SoundBuffer&& buffer) = delete;


    Sound(const Sound& copy);


    ~Sound() override;


    void play() override;


    void pause() override;


    void stop() override;


    void setBuffer(const SoundBuffer& buffer);


    void setBuffer(const SoundBuffer&& buffer) = delete;


    void setLooping(bool loop);


    void setPlayingOffset(Time timeOffset);


    void setEffectProcessor(EffectProcessor effectProcessor) override;


    [[nodiscard]] const SoundBuffer& getBuffer() const;


    [[nodiscard]] bool isLooping() const;


    [[nodiscard]] Time getPlayingOffset() const;


    [[nodiscard]] Status getStatus() const override;


    Sound& operator=(const Sound& right);


private:

    friend class SoundBuffer;


    void detachBuffer();


    [[nodiscard]] void* getSound() const override;


    // 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

SoundSource.hpp

sf::SoundBuffer
Storage for audio samples defining a sound.
Definition SoundBuffer.hpp:55

sf::SoundSource::SoundSource
SoundSource(const SoundSource &)=default
Copy constructor.

sf::SoundSource::EffectProcessor
std::function< void(const float *inputFrames, unsigned int &inputFrameCount, float *outputFrames, unsigned int &outputFrameCount, unsigned int frameChannelCount)> EffectProcessor
Callable that is provided with sound data for processing.
Definition SoundSource.hpp:154

sf::SoundSource::Status
Status
Enumeration of the sound source states.
Definition SoundSource.hpp:55

sf::Sound::getStatus
Status getStatus() const override
Get the current status of the sound (stopped, paused, playing)

sf::Sound::pause
void pause() override
Pause the sound.

sf::Sound::~Sound
~Sound() override
Destructor.

sf::Sound::setLooping
void setLooping(bool loop)
Set whether or not the sound should loop after reaching the end.

sf::Sound::Sound
Sound(const SoundBuffer &buffer)
Construct the sound with a buffer.

sf::Sound::Sound
Sound(const SoundBuffer &&buffer)=delete
Disallow construction from a temporary sound buffer.

sf::Sound::isLooping
bool isLooping() const
Tell whether or not the sound is in loop mode.

sf::Sound::SoundBuffer
friend class SoundBuffer
Definition Sound.hpp:223

sf::Sound::getPlayingOffset
Time getPlayingOffset() const
Get the current playing position of the sound.

sf::Sound::setBuffer
void setBuffer(const SoundBuffer &buffer)
Set the source buffer containing the audio data to play.

sf::Sound::operator=
Sound & operator=(const Sound &right)
Overload of assignment operator.

sf::Sound::stop
void stop() override
stop playing the sound

sf::Sound::play
void play() override
Start or resume playing the sound.

sf::Sound::setBuffer
void setBuffer(const SoundBuffer &&buffer)=delete
Disallow setting from a temporary sound buffer.

sf::Sound::getBuffer
const SoundBuffer & getBuffer() const
Get the audio buffer attached to the sound.

sf::Sound::setPlayingOffset
void setPlayingOffset(Time timeOffset)
Change the current playing position of the sound.

sf::Sound::setEffectProcessor
void setEffectProcessor(EffectProcessor effectProcessor) override
Set the effect processor to be applied to the sound.

sf::Sound::Sound
Sound(const Sound &copy)
Copy constructor.

sf::Time
Represents a time value.
Definition Time.hpp:42

sf
Definition AudioResource.hpp:36