Class UnityAudioPlayerClipDefinition

Unity ScriptableObject definition for individual audio clips used by the audio player system.
Stores audio clip references and metadata for game settings integration and asset management.

Inheritance
object
UnityAudioPlayerClipDefinition
Implements
Namespace: Serenity.AudioPlayer.Infrastructure.Settings
Assembly: Serenity.UnityAudioPlayer.Infrastructure.dll
Syntax
public class UnityAudioPlayerClipDefinition : ScriptableObject, IAudioPlayerClipDefinition, IFoundationSettings, IAudioPlayerClipSpatialSettingsDefinition

Constructors

UnityAudioPlayerClipDefinition()

Declaration
public UnityAudioPlayerClipDefinition()

Fields

AudioClip

Declaration
public AudioClip AudioClip
Field Value
Type Description
AudioClip

Reference to the audio clip asset.

AudioClipPath

Declaration
public string AudioClipPath
Field Value
Type Description
string

Path to the audio clip asset in the project.

CanBeReplaced

Declaration
public bool CanBeReplaced
Field Value
Type Description
bool

Whether a sound started from this definition may be reassigned to make room for a higher-priority sound.

CustomSpatialSettings

Declaration
public bool CustomSpatialSettings
Field Value
Type Description
bool

Whether the settings below apply to a positioned play. Off keeps the default positioned settings, so assets that lack these fields behave as before.

Guid

Declaration
public string Guid
Field Value
Type Description
string

GUID for this audio clip definition used by editor tools and serialization.

Id

Declaration
public string Id
Field Value
Type Description
string

Unique identifier for this audio clip definition.

MaxDistance

Declaration
public float MaxDistance
Field Value
Type Description
float

Metres beyond which a positioned play no longer attenuates. Used only while CustomSpatialSettings is on.

MinDistance

Declaration
public float MinDistance
Field Value
Type Description
float

Metres within which a positioned play is at full volume. Used only while CustomSpatialSettings is on.

Priority

Declaration
public int Priority
Field Value
Type Description
int

Serenity priority of the clip. Higher value = more important. Existing assets that predate this field deserialize to the field initializer below, keeping behavior safe.

PriorityPolicy

Declaration
public AudioPriorityPolicy PriorityPolicy
Field Value
Type Description
AudioPriorityPolicy

Policy used when the pool is full and this clip is requested. Defaults to IgnoreIfNoSourceAvailable so existing clips keep the original behavior.

RolloffMode

Declaration
public AudioRolloffMode RolloffMode
Field Value
Type Description
AudioRolloffMode

How the volume attenuates between the min and the max distance. Used only while CustomSpatialSettings is on.

Spread

Declaration
public float Spread
Field Value
Type Description
float

Speaker spread in degrees. Used only while CustomSpatialSettings is on.

Implements