ludus::audio::PlayParams¶

Struct

A single Play command's parameters (design sections 5-7).

All numeric; no pointers, closures or transient views.

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

#include <ludus/audio/audio_types.h>

struct ludus::audio::PlayParams final

Fields¶

Clip¶

ClipHandle ludus::audio::PlayParams::Clip {}

Related types: ClipHandle

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

BusIndex¶

uint32 ludus::audio::PlayParams::BusIndex = 0

index into the configured bus array

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

GroupIndex¶

uint32 ludus::audio::PlayParams::GroupIndex = 0

index into the configured group array

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

Priority¶

uint8 ludus::audio::PlayParams::Priority = PRIORITY_MIN

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

Gain¶

float32 ludus::audio::PlayParams::Gain = 1.0F

[0,1] linear

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

Rate¶

float32 ludus::audio::PlayParams::Rate = 1.0F

[RATE_MIN, RATE_MAX]

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

Looping¶

bool ludus::audio::PlayParams::Looping = false

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

Policy¶

VirtualPolicy ludus::audio::PlayParams::Policy = VirtualPolicy::KillWhenInaudible

Related types: VirtualPolicy

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

StartFrame¶

uint64 ludus::audio::PlayParams::StartFrame = 0

Scheduling.

StartFrame == 0 means "next applied boundary". Otherwise an absolute session frame no more than MAX_SCHEDULE_HORIZON_SECONDS ahead.

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

Positional¶

bool ludus::audio::PlayParams::Positional = false

Spatialization.

When Positional is false the voice is nonspatial and uses ExplicitPan directly (mono) or a stereo-bed scalar gain.

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

EmitterPosition¶

AudioVec3 ludus::audio::PlayParams::EmitterPosition {}

Related types: AudioVec3

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

Origin¶

AttenuationOrigin ludus::audio::PlayParams::Origin = AttenuationOrigin::Listener

Related types: AttenuationOrigin

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

MinDistance¶

float32 ludus::audio::PlayParams::MinDistance = 1.0F

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

MaxDistance¶

float32 ludus::audio::PlayParams::MaxDistance = 100.0F

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

ExplicitPan¶

float32 ludus::audio::PlayParams::ExplicitPan = 0.0F

[-1,1] for nonspatial mono

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

PolicyTag¶

uint32 ludus::audio::PlayParams::PolicyTag = 0

Owner-side numeric diagnostic tag (never interpreted by the renderer).

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