#include <Magnum/Audio/Playable.h>

template<UnsignedInt dimensions>

Magnum::Audio::Playable class

Usage

Attach the instance to an existing object and set a filled buffer to it. In order to reflect transformation changes from the scene in the spatial audio, the playable should be added to some PlayableGroup, which is periodically updated from a currently active Listener using Listener::update():

Scene3D scene;
Object3D object{&scene};
Audio::Buffer buffer;

// ...
Audio::Listener3D listener{scene};
Audio::PlayableGroup3D group;

/* Attach the playable to an object and configure its source */
Audio::Playable3D playable{object, &group};
playable.source()
    .setBuffer(&buffer)
    .setLooping(true)
    .play();

// ...

// every frame, adapt the listener and all playables to changes in scene
// transformation
listener.update({group, someOtherGroup});

Note that Source::setPosition(), Source::setDirection() and Source::setGain() called on source() will be overwritten on next call to Listener::update() / PlayableGroup::setGain() / setGain() and you have to use other means to update them:

• Transformation of the source is inherited from the scene. If you want to transform it, transform the SceneGraph::Object the playable is attached to. It's also possible to affect the global listener and group transformation using Listener::setSoundTransformation() and PlayableGroup::setSoundTransformation()
• The source is by default omnidirectional (i.e., passing a zero vector to Source::setDirection()). You can set the initial direction using the Playable(SceneGraph::AbstractObject<dimensions, Float>&, const VectorTypeFor<dimensions, Float>&, PlayableGroup<dimensions>*) constructor, the direction will be automatically rotated based on playable transformation.
• Source gain is set as a combination of PlayableGroup gain and Playable gain and updated on every call to setGain() or PlayableGroup::setGain().

Base classes

template<UnsignedInt dimensions, class Derived, class T>

class Magnum::SceneGraph::AbstractGroupedFeature<dimensions, Playable<dimensions>, Float>

Base for grouped features.

Constructors, destructors, conversion operators

Playable(SceneGraph::AbstractObject<dimensions, Float>& object, PlayableGroup<dimensions>* group = nullptr) explicit

Construct a playable with omnidirectional source.

Playable(SceneGraph::AbstractObject<dimensions, Float>& object, const VectorTypeFor<dimensions, Float>& direction, PlayableGroup<dimensions>* group = nullptr) explicit

Construct a playable with directional source.

Public functions

auto source() -> Source&

Source which is managed by this feature.

auto gain() const -> Float

Gain.

auto setGain(const Float gain) -> Playable&

Set gain of the playable and source respecting the PlayableGroups gain.

auto playables() -> PlayableGroup<dimensions>*

Group containing this playable.

auto playables() const -> const PlayableGroup<dimensions>*

Function documentation