logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface IAudioPlayerClipSpatialSettingsDefinition

    Optional companion of IAudioPlayerClipDefinition for definitions that let the author choose how a positioned play attenuates with distance.
    A separate interface, so implementers of IAudioPlayerClipDefinition keep compiling unchanged.

    Namespace: Serenity.AudioPlayer.Domain.Interfaces
    Assembly: Serenity.AudioPlayer.Domain.dll
    Syntax
    public interface IAudioPlayerClipSpatialSettingsDefinition

    Properties

    HasCustomSpatialSettings

    Declaration
    bool HasCustomSpatialSettings { get; }
    Property Value
    Type Description
    bool

    Gets whether the author chose the spatial settings below. When false they are ignored.

    MaxDistance

    Declaration
    float MaxDistance { get; }
    Property Value
    Type Description
    float

    Gets the distance, in metres, beyond which the sound no longer attenuates.

    MinDistance

    Declaration
    float MinDistance { get; }
    Property Value
    Type Description
    float

    Gets the distance, in metres, within which the sound is at full volume.

    RolloffMode

    Declaration
    AudioRolloffMode RolloffMode { get; }
    Property Value
    Type Description
    AudioRolloffMode

    Gets how the volume attenuates between the min and the max distance.

    Spread

    Declaration
    float Spread { get; }
    Property Value
    Type Description
    float

    Gets the speaker spread in degrees, from 0 to 360.

    In this article
    © 2026 Serenity. All Rights Reserved