ludus::audio::app::EventDescriptor¶

Struct

A typed, application-owned event descriptor (design section 9): it selects a prepared clip from a bounded variation list plus bus/group/priority/gain and spatial defaults.

Validated before playback; invalid fields are reported with a specific code so a designer can find the offending field without listening.

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

#include <ludus/audio/audio_app_adapter.h>

struct ludus::audio::app::EventDescriptor final

Fields¶

EventId¶

uint32 ludus::audio::app::EventDescriptor::EventId = 0

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

VariationCount¶

uint32 ludus::audio::app::EventDescriptor::VariationCount = 0

1..MAX_VARIATIONS

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Variations¶

ClipHandle ludus::audio::app::EventDescriptor::Variations[MAX_VARIATIONS][MAX_VARIATIONS] {}

prepared clip handles

Related types: ClipHandle

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

BusIndex¶

uint32 ludus::audio::app::EventDescriptor::BusIndex = 0

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

GroupIndex¶

uint32 ludus::audio::app::EventDescriptor::GroupIndex = 0

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Priority¶

uint8 ludus::audio::app::EventDescriptor::Priority = PRIORITY_MIN

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

DefaultGain¶

float32 ludus::audio::app::EventDescriptor::DefaultGain = 1.0F

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Rate¶

float32 ludus::audio::app::EventDescriptor::Rate = 1.0F

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Looping¶

bool ludus::audio::app::EventDescriptor::Looping = false

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Policy¶

VirtualPolicy ludus::audio::app::EventDescriptor::Policy = VirtualPolicy::KillWhenInaudible

Related types: VirtualPolicy

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

Positional¶

bool ludus::audio::app::EventDescriptor::Positional = false

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

MinDistance¶

float32 ludus::audio::app::EventDescriptor::MinDistance = 1.0F

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h

MaxDistance¶

float32 ludus::audio::app::EventDescriptor::MaxDistance = 100.0F

Declared in modules/audio/include/ludus/audio/audio_app_adapter.h