This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the archived version of this documentation page.

Magnum::Audio namespace

Audio playback.

Contents

Audio import, playback and integration with SceneGraph.

This library depends on the OpenAL library. It is built if WITH_AUDIO is enabled when building Magnum. To use this library with CMake, you need to request the Audio component of the Magnum package and link to the Magnum::Audio target:

find_package(Magnum REQUIRED Audio)

# ...
target_link_libraries(your-app Magnum::Audio)

See Downloading and building and Usage with CMake for more information.

Additional plugins are built separately, see particular Audio::*Importer class documentation, Downloading and building, Downloading and building plugins, Usage with CMake, Plugin usage with CMake and Loading and using plugins for more information.

Namespaces

namespace Extensions
Compile-time information about OpenAL extensions.

Classes

class AbstractImporter
Base for audio importer plugins.
class AnyImporter
Any audio importer plugin.
class Buffer
Sample buffer.
class Context
OpenAL context.
class DrFlacImporter
FLAC audio importer plugin using dr_flac.
class DrWavImporter
WAV audio importer plugin using dr_wav.
class Extension
Run-time information about OpenAL extension.
template<UnsignedInt dimensions>
class Listener
Listener.
template<UnsignedInt dimensions>
class Playable
Playable.
template<UnsignedInt dimensions>
class PlayableGroup
PlayableGroup.
class Renderer
Global renderer configuration.
class Source
Source.
class StbVorbisImporter
OGG audio importer plugin using stb_vorbis.
class WavImporter
WAV importer plugin.

Typedefs

using Playable2D = Playable<2>
Playable for two dimensional float scenes.
using Playable3D = Playable<3>
Playable for three dimensional float scenes.
using PlayableGroup2D = PlayableGroup<2>
Playable group for two dimensional float scenes.
using PlayableGroup3D = PlayableGroup<3>
Playable group for three dimensional float scenes.
using Listener2D = Listener<2>
Listener for two dimensional float scenes.
using Listener3D = Listener<3>
Listener for three dimensional float scenes.

Functions

auto operator<<(Debug& debug, Buffer::Format value) -> Debug&
Debug output operator.
auto operator<<(Debug& debug, Context::HrtfStatus value) -> Debug&
Debug output operator.
auto operator<<(Debug& debug, Renderer::Error value) -> Debug&
Debug output operator.
auto operator<<(Debug& debug, Renderer::DistanceModel value) -> Debug&
Debug output operator.
auto operator<<(Debug& debug, Source::State value) -> Debug&
Debug output operator.

Typedef documentation

typedef Playable<2> Magnum::Audio::Playable2D

Playable for two dimensional float scenes.

typedef Playable<3> Magnum::Audio::Playable3D

Playable for three dimensional float scenes.

typedef PlayableGroup<2> Magnum::Audio::PlayableGroup2D

Playable group for two dimensional float scenes.

typedef PlayableGroup<3> Magnum::Audio::PlayableGroup3D

Playable group for three dimensional float scenes.

typedef Listener<2> Magnum::Audio::Listener2D

Listener for two dimensional float scenes.

typedef Listener<3> Magnum::Audio::Listener3D

Listener for three dimensional float scenes.

Function documentation

Debug& Magnum::Audio::operator<<(Debug& debug, Buffer::Format value)

Debug output operator.


Debug& Magnum::Audio::operator<<(Debug& debug, Context::HrtfStatus value)

Debug output operator.


Debug& Magnum::Audio::operator<<(Debug& debug, Renderer::Error value)

Debug output operator.


Debug& Magnum::Audio::operator<<(Debug& debug, Renderer::DistanceModel value)

Debug output operator.


Debug& Magnum::Audio::operator<<(Debug& debug, Source::State value)

Debug output operator.