StateDeltaConfig
Value
State value name this delta applies to.
Type information: (Nullable) String
VolumeDb
Signed dB offset applied to voice gain when this state value is active. Ignored when Mute is true.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Mute
When true, forces the subscriber silent for this state value. Fading is still applied.
Type information: Boolean defaults to: false
PitchSemitones
Signed semitone offset applied to the subscriber's playback pitch when this state value is active. 0 = no change. 12 = one octave up, -12 = one octave down, -6 = half octave down (tritone), -60 = perceptually frozen / time-stop effect.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Fade
This subscriber's own ramp onto this state value, overriding field by field what the axis resolved. A transition override sent with the state change still outranks it. Omit so every subscriber moves together. Where more than one binding covers this axis, later ones refine earlier ones field by field. A later binding can set a field but cannot clear one back to the axis. Music composes ancestors, then the Segment, then the LayerPlacement, then the leaf container. A sound event composes its own before the AmbienceFX that plays it.
Type information:
(Nullable)
StateFadeConfig with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Duration | (Nullable)
BarBeatDuration
| How long this subscriber's ramp takes, as bars plus beats plus ms against its own tempo. A subscriber with no tempo takes the Ms component alone. Categories, ambient beds and sound events never have one, so author their fades in Ms. A music container needs a Tempo of its own, or one inherited from the Segment it is a direct layer of. Omit to take the length the axis resolved. | ||||||||||||
| Curve | (Nullable) Any one of the following String (defaults to Linear):
FadeCurve
| Interpolation curve shape. Read only when this fade supplies Duration. Alongside a Delay and no Duration it is ignored, and a Fade carrying nothing but a Curve is rejected. | ||||||||||||
| Delay | (Nullable)
BarBeatDuration
| How long this subscriber holds its old level past the boundary before its ramp starts. An audio category has no hold, so a delay lengthens its ramp instead. Non-negative: to begin before a boundary, move the boundary itself with SyncTo Offset. |