Stingers
Asset path: Server/Audio/Stingers/*.json
A musical one-shot played over the current music rather than replacing it.
Parent
When set this asset will inherit properties from the named asset.
When inheriting from another Stinger most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.
Type information: String
Tags
Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.
For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.
Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|---|
any String | Array of String |
MusicContainer
The container to play. A Random container gives free variation, a Segment allows a tempo and pre-entry pickup.
Type information:
(Nullable) Either String or MusicContainer
Reference to a MusicContainer asset
Priority
Arbitration rank within ExclusionGroup. Higher wins.
Type information: Integer defaults to: 0
ExclusionGroup
Stingers sharing a group compete: a firing stinger is dropped when an active one outranks it, and replaces it otherwise. Omit to compete with nothing.
Type information: (Nullable) String
MaxInstance
Concurrent voices allowed for this stinger. This cap is per asset.
Type information: Integer defaults to: 1
AudioCategory
Category the stinger routes to. Give it a dedicated category to duck the bed independently.
Type information: (Nullable) String
Reference to a AudioCategory asset
Volume
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DuckingRules
While this stinger is audible, each rule attenuates its TargetCategory.
Type information:
(Nullable) Array of the type:
AudioCategoryDuckingRuleConfig with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TargetCategory | (Nullable) String | Id of the AudioCategory this rule ducks. | ||||||||||||
| DuckingVolumeDb | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Authored ducking target in dB. | ||||||||||||
| AttackMs | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Milliseconds to tween from 0 dB (no duck) toward DuckingVolumeDb when the rule's source first becomes active. Zero snaps immediately. | ||||||||||||
| HoldMs | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Milliseconds to hold the duck at DuckingVolumeDb after the source becomes inactive. | ||||||||||||
| ReleaseMs | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Milliseconds to tween from the held duck value back toward the next-priority value. Zero snaps immediately. | ||||||||||||
| Curve | (Nullable) Any one of the following String (defaults to Linear):
FadeCurve
| Curve applied to the Attack tween. | ||||||||||||
| ReleaseCurve | (Nullable) Any one of the following String (defaults to Linear):
FadeCurve
| Curve applied to the Release tween. | ||||||||||||
| Priority | Integer defaults to: 0 | When multiple rules are active on the same target, only entries at the highest active priority contribute to the composite. Within a priority class, the most-negative dB wins. |