Open 3D Engine MiniAudio Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
MiniAudio::MiniAudioPlaybackComponentConfig Class Referencefinal

Inherits AZ::ComponentConfig.

Public Member Functions

 AZ_RTTI (MiniAudioPlaybackComponentConfig, "{b829e7ae-690f-4cf4-a350-e39929f206c2}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

AZ::Data::Asset< SoundAssetm_sound
 
bool m_autoplayOnActivate = false
 
float m_volume = 100.f
 Playback volume represented as a percentage.
 
bool m_autoFollowEntity = false
 If true, follow the position of the entity.
 
bool m_loop = false
 If true, loops the sound.
 
bool m_enableSpatialization = false
 
AttenuationModel m_attenuationModel = AttenuationModel::Inverse
 
float m_minimumDistance = 3.f
 
float m_maximumDistance = 30.f
 
float m_innerAngleInRadians = AZ::Constants::TwoPi
 Inner cone angle.
 
float m_innerAngleInDegrees = AZ::RadToDeg(m_innerAngleInRadians)
 
float m_outerAngleInRadians = AZ::Constants::TwoPi
 Outer cone angle.
 
float m_outerAngleInDegrees = AZ::RadToDeg(m_outerAngleInRadians)
 
float m_outerVolume = 0.f
 Volume outside of outer cone.
 
float m_directionalAttenuationFactor = 1.f
 Directional controls.
 
bool m_fixedDirection = false
 
AZ::Vector3 m_direction = AZ::Vector3::CreateAxisY(1.f)
 

Member Data Documentation

◆ m_autoplayOnActivate

bool MiniAudio::MiniAudioPlaybackComponentConfig::m_autoplayOnActivate = false

If true, automatically play when the entity activates, useful for environment audio.


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