dacha
    Preparing search index...

    Class AudioAPI

    API that provides synchronous audio mixer controls.

    Actor playback is controlled through AudioSource component state. This API is intended for global audio state such as group and master volume.

    Index
    constructor
    masterVolume
    getGroupVolume setGroupVolume

    • Parameters

      • handlers: AudioAPIHandlers

      Returns AudioAPI

    • get masterVolume(): number

      Current master volume.

      Returns number

    • set masterVolume(volume: number): void

      Sets the master volume.

      Parameters

      • volume: number

      Returns void

    • Returns the volume for an audio group.

      Parameters

      • group: string

        Audio group name

      Returns number

      Audio group volume

    • Sets the volume for an audio group.

      Parameters

      • group: string

        Audio group name

      • volume: number

        New group volume

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods