Struct ClipSpatialSettingsDraft

The five values of a clip definition's spatial group held apart from any asset: a batch importer row, the importer window's defaults and a recipe clip all carry one, and ApplyTo(UnityAudioPlayerClipDefinition) is the single place that writes it onto a definition. Public because the batch importer's row type and the recipe importer, which sit in other assemblies, use it.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Serenity.AudioPlayer.Infrastructure.Settings.Editor

Assembly: Serenity.UnityAudioPlayer.Infrastructure.Editor.dll

Syntax

public struct ClipSpatialSettingsDraft

Fields

CustomSpatialSettings

Whether the values below apply to a positioned play.

Declaration

public bool CustomSpatialSettings

Field Value

Type	Description
bool

MaxDistance

Metres beyond which a positioned play no longer attenuates.

Declaration

public float MaxDistance

Field Value

Type	Description
float

MinDistance

Metres within which a positioned play is at full volume.

Declaration

public float MinDistance

Field Value

Type	Description
float

RolloffMode

How the volume attenuates between the min and the max distance.

Declaration

public AudioRolloffMode RolloffMode

Field Value

Type	Description
AudioRolloffMode

Spread

Speaker spread in degrees.

Declaration

public float Spread

Field Value

Type	Description
float

Properties

Defaults

The group of an untouched definition: the toggle off and the default positioned values.

Declaration

public static ClipSpatialSettingsDraft Defaults { get; }

Property Value

Type	Description
ClipSpatialSettingsDraft

Methods

ApplyTo(UnityAudioPlayerClipDefinition)

Writes the five values onto definition.

Declaration

public void ApplyTo(UnityAudioPlayerClipDefinition definition)

Parameters

Type	Name	Description
UnityAudioPlayerClipDefinition	definition

DescribeInvalidWhenCustom()

The rule the values break while the toggle is on, or null when it is off or the group is valid.

Declaration

public string DescribeInvalidWhenCustom()

Returns

Type	Description
string