Sound.hpp

Go to the documentation of this file.

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

    explicit 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