Namespace dalia¶

Classes¶

Type	Name
struct	BiquadConfig
struct	EffectHandle Handle used to manage effect instances. This handle expires once the effect it is referencing has been destroyed.
class	Engine
struct	EngineConfig
struct	Listener3DAttributes A snapshot of a listener's 3D state in the world.
struct	PlaybackHandle Handle used to manage playback instances. This handle will expire once the playback instance it is referencing stops.
struct	SoundHandle Handle used to manage loaded sounds. This handle expires once the sound it is referencing is unloaded.
struct	Vec3 Standard 3D vector for the DALIA API.

Public Types¶

Type	Name
typedef std::function< void(uint32_t requestId, Result result)>	AssetLoadCallback A function that, if provided when loading an asset, will be called once the asset has been successfully loaded.
enum uint8_t	AttenuationCurve Curve used to calculate distance attenuation.
enum	BiquadFilterType Defines the frequency response shape of a standard biquadratic filter.
enum uint8_t	CoordinateSystem
enum uint8_t	DistanceMode Mode used to determine what listener position to use when calculating distance attenuation.
enum uint8_t	EffectType
typedef uint32_t	ListenerMask Routing mask used to target a specific listener. Can be combined to target multiple listeners using bitwise OR.
typedef std::function< void(LogLevel level, const char category, const char message)>	LogCallback
enum int	LogLevel
typedef std::function< void(PlaybackHandle handle, PlaybackExitCondition exitCondition)>	PlaybackExitCallback A function that, if provided when creating a playback instance, will be called when the playback instance is stopped.
enum uint8_t	PlaybackExitCondition The condition under which a playback instance was stopped.
enum int	Result
enum uint8_t	SoundType

Public Attributes¶

Type	Name
constexpr uint32_t	INVALID_REQUEST_ID = `0`
constexpr EffectHandle	InvalidEffectHandle = `{}`
constexpr PlaybackHandle	InvalidPlaybackHandle = `{}`
constexpr ListenerMask	MASK_ALL_LISTENERS = `0xFFFFFFFF`
constexpr ListenerMask	MASK_LISTENER_0 = `0b00000001`
constexpr ListenerMask	MASK_LISTENER_1 = `0b00000010`
constexpr ListenerMask	MASK_LISTENER_2 = `0b00000100`
constexpr ListenerMask	MASK_LISTENER_3 = `0b00001000`
constexpr ListenerMask	MASK_NONE = `0b00000000`

Public Functions¶

Type	Name
constexpr const char *	GetResultString (const Result result)
constexpr Listener3DAttributes	MakeListener3DAttributes (const Vec3 & position, const Vec3 & forward, const Vec3 & up, const Vec3 & velocity) Constructs a listener transform for a listener that performs panning and attenuation logic from the same world position.
constexpr Listener3DAttributes	MakeListener3DAttributesSplit (const Vec3 & position, const Vec3 & probePosition, const Vec3 & forward, const Vec3 & up, const Vec3 & velocity) Constructs a listener transform for a listener that performs panning and attenuation logic from two separate positions.
constexpr ListenerMask	MakeListenerMask (uint32_t listenerIndex) Creates a routing mask targeting a specific listener.

Public Types Documentation¶

typedef AssetLoadCallback¶

A function that, if provided when loading an asset, will be called once the asset has been successfully loaded.

using dalia::AssetLoadCallback = typedef std::function<void(uint32_t requestId, Result result)>;

enum AttenuationCurve¶

Curve used to calculate distance attenuation.

enum dalia::AttenuationCurve {
    InverseSquare,
    Linear,
    Quadratic
};

enum BiquadFilterType¶

Defines the frequency response shape of a standard biquadratic filter.

enum dalia::BiquadFilterType {
    LowPass,
    HighPass,
    BandPass
};

enum CoordinateSystem¶

enum dalia::CoordinateSystem {
    RightHanded,
    LeftHanded
};

enum DistanceMode¶

Mode used to determine what listener position to use when calculating distance attenuation.

enum dalia::DistanceMode {
    FromListener,
    FromDistanceProbe
};

enum EffectType¶

enum dalia::EffectType {
    None = 0,
    Biquad
};

typedef ListenerMask¶

Routing mask used to target a specific listener. Can be combined to target multiple listeners using bitwise OR.

using dalia::ListenerMask = typedef uint32_t;

typedef LogCallback¶

using dalia::LogCallback = typedef std::function<void(LogLevel level, const char* category, const char* message)>;

enum LogLevel¶

enum dalia::LogLevel {
    Debug = 0,
    Info = 1,
    Warning = 2,
    Error = 3,
    Critical = 4,
    None = 5
};

typedef PlaybackExitCallback¶

A function that, if provided when creating a playback instance, will be called when the playback instance is stopped.

using dalia::PlaybackExitCallback = typedef std::function<void(PlaybackHandle handle, PlaybackExitCondition exitCondition)>;

enum PlaybackExitCondition¶

The condition under which a playback instance was stopped.

enum dalia::PlaybackExitCondition {
    None = 0,
    NaturalEnd = 1,
    ExplicitStop = 2,
    Evicted = 3,
    Error = 4
};

enum Result¶

enum dalia::Result {
    Ok = 0,
    Error = -1,
    NotInitialized = -2,
    AlreadyInitialized = -3,
    InvalidHandle = -4,
    ExpiredHandle = -5,
    BusNotFound = -6,
    InvalidRouting = -7,
    InvalidEffectSlot = -8,
    ListenerNotFound = -9,
    PoolExhausted = -100,
    ResidentSoundPoolExhausted = -101,
    StreamSoundPoolExhausted = -102,
    VoicePoolExhausted = -103,
    StreamPoolExhausted = -104,
    BusPoolExhausted = -105,
    BiquadFilterPoolExhausted = -106,
    RtCommandQueueFull = -200,
    RtEventQueueFull = -201,
    IoStreamRequestQueueFull = -202,
    IoLoadRequestQueueFull = -203,
    PlaybackCorrupted = -303,
    SoundLoadError = -400,
    FileReadError = -401,
    UnsupportedFormat = -402,
    SystemError = -500,
    DeviceNotFound = -501,
    DeviceFailed = -502,
    ClientFailed = -503
};

enum SoundType¶

enum dalia::SoundType {
    None = 0,
    Resident = 1,
    Stream = 2
};

Public Attributes Documentation¶

variable INVALID_REQUEST_ID¶

constexpr uint32_t dalia::INVALID_REQUEST_ID;

variable InvalidEffectHandle¶

constexpr EffectHandle dalia::InvalidEffectHandle;

variable InvalidPlaybackHandle¶

constexpr PlaybackHandle dalia::InvalidPlaybackHandle;

variable MASK_ALL_LISTENERS¶

constexpr ListenerMask dalia::MASK_ALL_LISTENERS;

variable MASK_LISTENER_0¶

constexpr ListenerMask dalia::MASK_LISTENER_0;

variable MASK_LISTENER_1¶

constexpr ListenerMask dalia::MASK_LISTENER_1;

variable MASK_LISTENER_2¶

constexpr ListenerMask dalia::MASK_LISTENER_2;

variable MASK_LISTENER_3¶

constexpr ListenerMask dalia::MASK_LISTENER_3;

variable MASK_NONE¶

constexpr ListenerMask dalia::MASK_NONE;

Public Functions Documentation¶

function GetResultString¶

constexpr const char * dalia::GetResultString (
    const Result result
)

function MakeListener3DAttributes¶

Constructs a listener transform for a listener that performs panning and attenuation logic from the same world position.

inline constexpr Listener3DAttributes dalia::MakeListener3DAttributes (
    const Vec3 & position,
    const Vec3 & forward,
    const Vec3 & up,
    const Vec3 & velocity
)

function MakeListener3DAttributesSplit¶

Constructs a listener transform for a listener that performs panning and attenuation logic from two separate positions.

inline constexpr Listener3DAttributes dalia::MakeListener3DAttributesSplit (
    const Vec3 & position,
    const Vec3 & probePosition,
    const Vec3 & forward,
    const Vec3 & up,
    const Vec3 & velocity
)

function MakeListenerMask¶

Creates a routing mask targeting a specific listener.

inline constexpr ListenerMask dalia::MakeListenerMask (
    uint32_t listenerIndex
)

@Note[Combining masks] Multiple masks can be combined using bitwise OR.

Parameters:

listenerIndex The zero-based index of the listener to target.

Returns:

A bitmask with the corresponding listener's bit enabled.

The documentation for this class was generated from the following file engine/include/dalia/audio/EffectControl.h