jngl/sound_8hpp_source.html

// Copyright 2012-2024 Jan Niklas Hasse <jhasse@bixense.com>

// For conditions of distribution and use, see copyright notice in LICENSE.txt

#pragma once


#include "Finally.hpp"


#include <memory>

#include <string>


namespace jngl {


class SoundFile;


float getVolume();


void play(const std::string& filename);


void stop(const std::string& filename);


bool isPlaying(const std::string& filename);


std::shared_ptr<SoundFile> loop(const std::string& filename);


void setPlaybackSpeed(float speed);


void setVolume(float volume);


[[nodiscard]] Finally pauseAudio();


} // namespace jngl

Finally.hpp
Contains jngl::Finally class.

std::string

jngl::Finally
Helper class which calls a function when being destroyed.
Definition Finally.hpp:22

std::function

memory

jngl
JNGL's main namespace.
Definition Achievement.hpp:10

jngl::isPlaying
bool isPlaying(const std::string &filename)

jngl::setVolume
void setVolume(float volume)
Set global volume in [0, ∞]. Default is 1.0f.

jngl::setPlaybackSpeed
void setPlaybackSpeed(float speed)
Set global pitch in (0.0f, ∞]. Default is 1.0f.

jngl::play
void play(const std::string &filename)
Play an OGG audio file once.

jngl::loop
std::shared_ptr< SoundFile > loop(const std::string &filename)
Play an OGG audio file in a loop.

jngl::stop
void stop(const std::string &filename)
Stop an OGG audio file if it's currently playing.

jngl::pauseAudio
Finally pauseAudio()
Pauses the playback of all audio; destroying the returned Finally object will resume again.

string