documentation/3.0.1/Music_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 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/SoundStream.hpp>


#include <filesystem>

#include <memory>

#include <optional>


#include <cstddef>

#include <cstdint>


namespace sf

{

class Time;

class InputStream;

class InputSoundFile;


class SFML_AUDIO_API Music : public SoundStream

{

public:

    template <typename T>


    struct Span

    {

        T offset{};

        T length{};

    };


    // Associated `Span` type

    using TimeSpan = Span<Time>;


    Music();


    explicit Music(const std::filesystem::path& filename);


    Music(const void* data, std::size_t sizeInBytes);


    explicit Music(InputStream& stream);


    ~Music() override;


    Music(Music&&) noexcept;


    Music& operator=(Music&&) noexcept;


    [[nodiscard]] bool openFromFile(const std::filesystem::path& filename);


    [[nodiscard]] bool openFromMemory(const void* data, std::size_t sizeInBytes);


    [[nodiscard]] bool openFromStream(InputStream& stream);


    [[nodiscard]] Time getDuration() const;


    [[nodiscard]] TimeSpan getLoopPoints() const;


    void setLoopPoints(TimeSpan timePoints);


protected:

    [[nodiscard]] bool onGetData(Chunk& data) override;


    void onSeek(Time timeOffset) override;


    std::optional<std::uint64_t> onLoop() override;


private:

    [[nodiscard]] std::uint64_t timeToSamples(Time position) const;


    [[nodiscard]] Time samplesToTime(std::uint64_t samples) const;


    // Member data

    struct Impl;

    std::unique_ptr<Impl> m_impl;

};


} // namespace sf


Export.hpp

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

SoundStream.hpp

sf::InputSoundFile
Provide read access to sound files.
Definition InputSoundFile.hpp:52

sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46

sf::Music::Music
Music()
Default constructor.

sf::Music::onSeek
void onSeek(Time timeOffset) override
Change the current playing position in the stream source.

sf::Music::onLoop
std::optional< std::uint64_t > onLoop() override
Change the current playing position in the stream source to the loop offset.

sf::Music::getDuration
Time getDuration() const
Get the total duration of the music.

sf::Music::openFromStream
bool openFromStream(InputStream &stream)
Open a music from an audio file in a custom stream.

sf::Music::Music
Music(Music &&) noexcept
Move constructor.

sf::Music::onGetData
bool onGetData(Chunk &data) override
Request a new chunk of audio samples from the stream source.

sf::Music::Music
Music(const std::filesystem::path &filename)
Construct a music from an audio file.

sf::Music::TimeSpan
Span< Time > TimeSpan
Definition Music.hpp:67

sf::Music::openFromFile
bool openFromFile(const std::filesystem::path &filename)
Open a music from an audio file.

sf::Music::getLoopPoints
TimeSpan getLoopPoints() const
Get the positions of the of the sound's looping sequence.

sf::Music::Music
Music(InputStream &stream)
Construct a music from an audio file in a custom stream.

sf::Music::Music
Music(const void *data, std::size_t sizeInBytes)
Construct a music from an audio file in memory.

sf::Music::setLoopPoints
void setLoopPoints(TimeSpan timePoints)
Sets the beginning and duration of the sound's looping sequence using sf::Time

sf::Music::openFromMemory
bool openFromMemory(const void *data, std::size_t sizeInBytes)
Open a music from an audio file in memory.

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

sf::SoundStream::SoundStream
SoundStream(SoundStream &&) noexcept
Move constructor.

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

sf
Definition AudioResource.hpp:36

sf::Music::Span
Structure defining a time range using the template type.
Definition Music.hpp:61

sf::Music::Span< Time >::offset
Time offset
Definition Music.hpp:62

sf::Music::Span< Time >::length
Time length
Definition Music.hpp:63

sf::SoundStream::Chunk
Structure defining a chunk of audio data to stream.
Definition SoundStream.hpp:59