Class RecipeAudioClipDto

Recipe description of a single AudioPlayer clip definition. Maps to a UnityAudioPlayerClipDefinition asset.

Inheritance

object

RecipeAudioClipDto

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.ProjectRecipe.Infrastructure.Editor.Model

Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll

Syntax

public class RecipeAudioClipDto

Constructors

RecipeAudioClipDto()

Declaration

public RecipeAudioClipDto()

Fields

canBeReplaced

Declaration

public bool canBeReplaced

Field Value

Type	Description
bool	Whether a sound from this clip may be reassigned to free a source. Defaults to true.

customSpatialSettings

Declaration

public bool customSpatialSettings

Field Value

Type	Description
bool	Whether the four values below apply when the clip is played at a world position. Defaults to false, which keeps the default positioned settings; importing a recipe without this key turns the group off.

id

Declaration

public string id

Field Value

Type	Description
string	Stable logical identifier (becomes the asset's Id). Required.

maxDistance

Declaration

public float maxDistance

Field Value

Type	Description
float	Metres beyond which a positioned play no longer attenuates; must be greater than minDistance.

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 true.

output

Declaration

public string output

Field Value

Type	Description
string	Output path relative to outputRoot, ending in .asset. Required.

priority

Declaration

public int priority

Field Value

Type	Description
int	Serenity priority; higher = more important. Defaults to 50.

priorityPolicy

Declaration

public string priorityPolicy

Field Value

Type	Description
string	Pool-full policy, as an AudioPriorityPolicy name (IgnoreIfNoSourceAvailable, ReplaceLowerPriority, ReplaceLowerOrEqualPriority, AlwaysReplace). Empty leaves the asset default.

rolloffMode

Declaration

public string rolloffMode

Field Value

Type	Description
string	Rolloff, as an AudioRolloffMode name: Logarithmic or Linear. Empty means Logarithmic; Custom is rejected because a clip cannot store a custom curve.

source

Declaration

public string source

Field Value

Type	Description
string	Project path to an existing AudioClip asset (e.g. Assets/Game/Media/jump.wav). Required.

spread

Declaration

public float spread

Field Value

Type	Description
float	Speaker spread in degrees, from 0 to 360.