VAE - Virtual Audio Engine 1
Small Data Driven Audio Engine
vae::core::Voice Struct Reference

Barebones voice. More...

#include <vae_voice.hpp>

Collaboration diagram for vae::core::Voice:

Public Attributes

bool spatialized: 1
 If the voice has spatialization data. More...
 
bool chainedEvents: 1
 If this voice triggers events after it stopped playing. More...
 
bool started: 1
 Whether the voice has started playing. More...
 
bool audible: 1
 Whether the voice was heard by any listener. More...
 
bool HRTF: 1
 If the voice should be rendered using hrtfs. More...
 
bool loop: 1
 Voice will loop until killed. More...
 
bool filtered: 1
 This will enable high/lowpass filters and variable speed playback. Gets turned on when signal does not match EngineStaticConfig::internalSampleRate. More...
 
bool critical: 1
 Voice can't be killed in favor of new voice. More...
 
bool attenuate: 1
 Whether distance affects volume. More...
 
BankHandle bank
 Which bank it belongs to. More...
 
SourceHandle source = InvalidSourceHandle
 If invalid, means voice is not playing. More...
 
EventHandle event
 Which event triggered the voice to be played. More...
 
EmitterHandle emitter
 Emitter used to control voice properties. More...
 
MixerHandle mixer
 Where the voice should mix to. More...
 
ListenerHandle listener
 If it's spatialized it's rendered for this listener. More...
 
Sample gain = 1.0
 Volume of the voice. More...
 
SampleIndex time = 0
 Current time in samples. More...
 

Detailed Description

Barebones voice.

Enough to play back a non spatialized and non filtered sound. Other structs extend this and depend on it

See also
VoicePan
VoiceHRTF
VoiceFilter

Definition at line 17 of file vae_voice.hpp.

Member Data Documentation

◆ attenuate

bool vae::core::Voice::attenuate

Whether distance affects volume.

Definition at line 26 of file vae_voice.hpp.

◆ audible

bool vae::core::Voice::audible

Whether the voice was heard by any listener.

Definition at line 21 of file vae_voice.hpp.

◆ bank

BankHandle vae::core::Voice::bank

Which bank it belongs to.

Definition at line 27 of file vae_voice.hpp.

◆ chainedEvents

bool vae::core::Voice::chainedEvents

If this voice triggers events after it stopped playing.

Definition at line 19 of file vae_voice.hpp.

◆ critical

bool vae::core::Voice::critical

Voice can't be killed in favor of new voice.

Definition at line 25 of file vae_voice.hpp.

◆ emitter

EmitterHandle vae::core::Voice::emitter

Emitter used to control voice properties.

Definition at line 30 of file vae_voice.hpp.

◆ event

EventHandle vae::core::Voice::event

Which event triggered the voice to be played.

Definition at line 29 of file vae_voice.hpp.

◆ filtered

bool vae::core::Voice::filtered

This will enable high/lowpass filters and variable speed playback. Gets turned on when signal does not match EngineStaticConfig::internalSampleRate.

Definition at line 24 of file vae_voice.hpp.

◆ gain

Sample vae::core::Voice::gain = 1.0

Volume of the voice.

Definition at line 33 of file vae_voice.hpp.

◆ HRTF

bool vae::core::Voice::HRTF

If the voice should be rendered using hrtfs.

Definition at line 22 of file vae_voice.hpp.

◆ listener

ListenerHandle vae::core::Voice::listener

If it's spatialized it's rendered for this listener.

Definition at line 32 of file vae_voice.hpp.

◆ loop

bool vae::core::Voice::loop

Voice will loop until killed.

Definition at line 23 of file vae_voice.hpp.

◆ mixer

MixerHandle vae::core::Voice::mixer

Where the voice should mix to.

Definition at line 31 of file vae_voice.hpp.

◆ source

SourceHandle vae::core::Voice::source = InvalidSourceHandle

If invalid, means voice is not playing.

Definition at line 28 of file vae_voice.hpp.

◆ spatialized

bool vae::core::Voice::spatialized

If the voice has spatialization data.

Definition at line 18 of file vae_voice.hpp.

◆ started

bool vae::core::Voice::started

Whether the voice has started playing.

Definition at line 20 of file vae_voice.hpp.

◆ time

SampleIndex vae::core::Voice::time = 0

Current time in samples.

Definition at line 34 of file vae_voice.hpp.


The documentation for this struct was generated from the following file: