Class AudioSettings

Audio settings container.

Inheritance

ISerializable

SettingsBase

AudioSettings

Inherited Members

SettingsBase::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

AudioSettings

SettingsBase::Serialize(SerializeStream& stream, const void* otherObj)

AudioSettings

AudioSettings

ISerializable::~ISerializable()

Assembly: FlaxEngine.dll

File: Engine/Audio/AudioSettings.h

Syntax

public class AudioSettings : public SettingsBase

Fields

DisableAudio

If checked, audio playback will be disabled in build game. Can be used if game uses custom audio playback engine.

Declaration

public bool DisableAudio = false

Field Value

bool

DopplerFactor

The doppler effect factor. Scale for source and listener velocities. Default is 1.

Declaration

public float DopplerFactor = 1.0f

Field Value

float

EnableHRTF

Enables or disables HRTF audio for in-engine processing of 3D audio (if supported by platform). If enabled, the user should be using two-channel/headphones audio output and have all other surround virtualization disabled (Atmos, DTS:X, vendor specific, etc.)

Declaration

public bool EnableHRTF = false

Field Value

bool

MuteOnFocusLoss

True if mute all audio playback when game has no use focus.

Declaration

public bool MuteOnFocusLoss = true

Field Value

bool

Methods

Apply()

Applies the settings to the target system.

Declaration

public virtual void Apply() override

Overrides

SettingsBase::Apply()

Get()

Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

Declaration

public static AudioSettings* Get()

Returns

AudioSettings