logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface IAudioPlayerClipDefinition

    Interface defining the structure and properties of an audio player clip definition.

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

    Properties

    AudioClip

    Declaration
    object AudioClip { get; }
    Property Value
    Type Description
    object

    Gets the audio clip associated with the definition.

    AudioClipPath

    Declaration
    string AudioClipPath { get; }
    Property Value
    Type Description
    string

    Gets the file path to the audio clip.

    CanBeReplaced

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

    Gets whether a sound started from this definition is allowed to be reassigned to make room for a higher-priority sound.

    Priority

    Declaration
    int Priority { get; }
    Property Value
    Type Description
    int

    Gets the Serenity priority of the clip. Higher value = more important. This is independent of (and inverted relative to) Unity's AudioSource.priority.

    PriorityPolicy

    Declaration
    AudioPriorityPolicy PriorityPolicy { get; }
    Property Value
    Type Description
    AudioPriorityPolicy

    Gets the policy that decides whether this clip may take over a busy AudioSource when the pool is full.

    In this article
    © 2026 Serenity. All Rights Reserved