jngl/Channel_8hpp_source.html

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

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


#include "Finally.hpp"


#include <memory>

#include <string>


namespace jngl {


class SoundFile;

struct Stream;


class Channel {

public:

    Channel();

    ~Channel();


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


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


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


    [[nodiscard]] Finally pause();


    void setVolume(float volume);


    static Channel& main();


    void add(std::shared_ptr<Stream>);

    void remove(const Stream*);


private:

    struct Impl;

    std::unique_ptr<Impl> impl;

};


} // namespace jngl

Finally.hpp
Contains jngl::Finally class.

std::string

jngl::Channel
An audio channel, different channels could be for example: "Music", "Speech" and "Sound Effects".
Definition Channel.hpp:29

jngl::Channel::pause
Finally pause()
Pauses the Channel; destroying the returned Finally object will resume again.

jngl::Channel::main
static Channel & main()
Returns the main Channel on which jngl::play, jngl::loop, jngl::stop operate.

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

jngl::Channel::remove
void remove(const Stream *)
Internal function for now.

jngl::Channel::add
void add(std::shared_ptr< Stream >)
Internal function for now.

jngl::Channel::play
void play(const std::string &filename)
Play OGG file on this channel.

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

jngl::Channel::stop
void stop(const std::string &filename)
Stop OGG file playing on this channel.

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

string