Search Results for

    Show / Hide Table of Contents

    Class AudioSettings

    Audio settings container.

    Inheritance
    System.Object
    SettingsBase
    AudioSettings
    Namespace: FlaxEditor.Content.Settings
    Assembly: FlaxEngine.CSharp.dll
    Syntax
    public sealed class AudioSettings : SettingsBase

    Constructors

    AudioSettings()

    Initializes a new instance of the AudioSettings.

    Declaration
    public AudioSettings()

    Fields

    DisableAudio

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

    Declaration
    [EditorOrder(0)]
    [EditorDisplay("General", null)]
    public bool DisableAudio
    Field Value
    System.Boolean

    DopplerFactor

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

    Declaration
    [EditorOrder(100)]
    [EditorDisplay("General", null)]
    public float DopplerFactor
    Field Value
    System.Single

    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
    [EditorOrder(300)]
    [EditorDisplay("Spatial Audio", null)]
    public bool EnableHRTF
    Field Value
    System.Boolean

    MuteOnFocusLoss

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

    Declaration
    [EditorOrder(200)]
    [EditorDisplay("General", "Mute On Focus Loss")]
    public bool MuteOnFocusLoss
    Field Value
    System.Boolean

    Extension Methods

    Extensions.ReflectiveCompare<T>(T, T)
    Extensions.DeepClone<T>(T)
    Extensions.RawClone<T>(T)
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat