MusicContainers
Asset path: Server/Audio/MusicContainers/*.json
This object has different properties depending on the value of the Type property.
All possible options are listed below:
Horizontal
A music container designed for horizontal dynamic music, where transitions go from segment to segment.
HorizontalMusicContainer with the following properties:
| Key | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Constant value: Horizontal | This field controls the type, it must be set to the constant value "Horizontal" to function as this type. | ||||||||||||||||||
| Parent | String | When set this asset will inherit properties from the named asset. When inheriting from another HorizontalMusicContainer 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. | ||||||||||||||||||
| Volume | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||||||||||||||
| LoopCount | Integer defaults to: 1 | Number of times to loop. 0 = infinite. | ||||||||||||||||||
| Weight | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Relative weight for random selection when parent is a Random container. | ||||||||||||||||||
| SilenceAfter | (Nullable)
Rangef
| Random silence range (seconds) after this container completes as a child. | ||||||||||||||||||
| ExitSilence | (Nullable)
Rangef
| Random silence range (seconds) when this top-level container is replaced by another. Only valid in top-level containers. | ||||||||||||||||||
| FadeInDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-in duration in seconds. | ||||||||||||||||||
| FadeOutDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-out duration in seconds. | ||||||||||||||||||
| TransitionType | (Nullable) Any one of the following String (defaults to FadeOutFadeIn):
MusicTransitionType
| How a switch into this container behaves when no MusicTransition rule matches, and how a Horizontal parent moves into it. | ||||||||||||||||||
| TransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Per-child override for transition duration. 0 = use parent's default. | ||||||||||||||||||
| ExitAt | (Nullable)
MusicSyncConfig
| When the container playing hands over to this one, on that container's grid. Omit to let TransitionType decide: Immediate hands over at once, Crossfade at the outgoing container's exit marker, FadeOutFadeIn on the next bar. A matched MusicTransition overrides this. | ||||||||||||||||||
| Align | (Nullable) Any one of the following String:
DestinationAlign
| Where this container starts when a transition places it, on its own timeline. Omit to land its entry marker on the handoff. SamePosition carries the outgoing playhead across, which lines up only between arrangements sharing a grid and a loop length, so it suits a Horizontal phase and is rarely right between unrelated containers. Nothing checks that the lengths agree unless a MusicTransition spans the pair. A container seeked mid-file keeps a few milliseconds of fade even under a transition type that asks for none, since cutting into a waveform clicks. A matched MusicTransition overrides this. A phase reached by the previous one ending has no handoff to land against, so it starts at its own beginning. | ||||||||||||||||||
| AlignMarker | (Nullable) String | Marker of this container to align to. Only used with Align: NamedMarker. | ||||||||||||||||||
| PlayToCompletion | Boolean defaults to: false | If true, this container plays to completion before yielding to higher-priority music. | ||||||||||||||||||
| ResumeMemoryDuration | (Nullable) Either Number defaults to: 30.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How long to retain this container's playback state after leaving so a return resumes mid-track instead of restarting. | ||||||||||||||||||
| NameTranslationKey | (Nullable) String | Translation key for the display name of this music container. | ||||||||||||||||||
| AudioCategory | (Nullable) String | Audio category for volume routing. Honoured on any container, and the nearest one up the hierarchy from a playing leaf wins. | ||||||||||||||||||
| Tempo | (Nullable)
TempoSettings
| Tempo and beat grid settings. | ||||||||||||||||||
| StateBindings | (Nullable) Array of the type:
StateBindingConfig
| Subscribe this container to one or more AudioState axes. Per-state volume deltas will be applied to the container and its descendants. | ||||||||||||||||||
| Stingers | (Nullable) Array of the type:
StingerBindingConfig
| Answer music events with stingers. Inherited by descendants. The deepest binding for an event wins, so a parent can give a default that a child overrides. | ||||||||||||||||||
| DefaultPhaseTransitionType | (Nullable) Any one of the following String (defaults to Crossfade):
MusicTransitionType
| Transition type for every phase change. A child overrides it with its own TransitionType, but only when the child also sets a TransitionDuration: TransitionType has no 'unset' value. | ||||||||||||||||||
| DefaultPhaseTransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Default transition duration for all phase transitions. | ||||||||||||||||||
| Children | Array of the type: Either String or MusicContainer | |||||||||||||||||||
| AudioState | (Nullable) String | Axis that selects which phase plays. Omit and the container only advances sequentially. | ||||||||||||||||||
| Phases | (Nullable) Array of the type:
PhaseSelection
| Which phase each state value selects. Values not listed leave the current phase alone. | ||||||||||||||||||
| Tags | (Nullable) Map of the following:
Map
| 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. |
Random
A randomized music container.
RandomMusicContainer with the following properties:
| Key | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Constant value: Random | This field controls the type, it must be set to the constant value "Random" to function as this type. | ||||||||||||||||||
| Parent | String | When set this asset will inherit properties from the named asset. When inheriting from another RandomMusicContainer 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. | ||||||||||||||||||
| Volume | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||||||||||||||
| LoopCount | Integer defaults to: 1 | Number of times to loop. 0 = infinite. | ||||||||||||||||||
| Weight | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Relative weight for random selection when parent is a Random container. | ||||||||||||||||||
| SilenceAfter | (Nullable)
Rangef
| Random silence range (seconds) after this container completes as a child. | ||||||||||||||||||
| ExitSilence | (Nullable)
Rangef
| Random silence range (seconds) when this top-level container is replaced by another. Only valid in top-level containers. | ||||||||||||||||||
| FadeInDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-in duration in seconds. | ||||||||||||||||||
| FadeOutDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-out duration in seconds. | ||||||||||||||||||
| TransitionType | (Nullable) Any one of the following String (defaults to FadeOutFadeIn):
MusicTransitionType
| How a switch into this container behaves when no MusicTransition rule matches, and how a Horizontal parent moves into it. | ||||||||||||||||||
| TransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Per-child override for transition duration. 0 = use parent's default. | ||||||||||||||||||
| ExitAt | (Nullable)
MusicSyncConfig
| When the container playing hands over to this one, on that container's grid. Omit to let TransitionType decide: Immediate hands over at once, Crossfade at the outgoing container's exit marker, FadeOutFadeIn on the next bar. A matched MusicTransition overrides this. | ||||||||||||||||||
| Align | (Nullable) Any one of the following String:
DestinationAlign
| Where this container starts when a transition places it, on its own timeline. Omit to land its entry marker on the handoff. SamePosition carries the outgoing playhead across, which lines up only between arrangements sharing a grid and a loop length, so it suits a Horizontal phase and is rarely right between unrelated containers. Nothing checks that the lengths agree unless a MusicTransition spans the pair. A container seeked mid-file keeps a few milliseconds of fade even under a transition type that asks for none, since cutting into a waveform clicks. A matched MusicTransition overrides this. A phase reached by the previous one ending has no handoff to land against, so it starts at its own beginning. | ||||||||||||||||||
| AlignMarker | (Nullable) String | Marker of this container to align to. Only used with Align: NamedMarker. | ||||||||||||||||||
| PlayToCompletion | Boolean defaults to: false | If true, this container plays to completion before yielding to higher-priority music. | ||||||||||||||||||
| ResumeMemoryDuration | (Nullable) Either Number defaults to: 600.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How long to retain this container's playback state after leaving so a return resumes mid-track instead of restarting. | ||||||||||||||||||
| NameTranslationKey | (Nullable) String | Translation key for the display name of this music container. | ||||||||||||||||||
| AudioCategory | (Nullable) String | Audio category for volume routing. Honoured on any container, and the nearest one up the hierarchy from a playing leaf wins. | ||||||||||||||||||
| Tempo | (Nullable)
TempoSettings
| Tempo and beat grid settings. | ||||||||||||||||||
| StateBindings | (Nullable) Array of the type:
StateBindingConfig
| Subscribe this container to one or more AudioState axes. Per-state volume deltas will be applied to the container and its descendants. | ||||||||||||||||||
| Stingers | (Nullable) Array of the type:
StingerBindingConfig
| Answer music events with stingers. Inherited by descendants. The deepest binding for an event wins, so a parent can give a default that a child overrides. | ||||||||||||||||||
| Mode | (Nullable) Any one of the following String (defaults to Shuffle):
RandomMode
| Shuffle = even distribution. Random = weighted per-pick selection. | ||||||||||||||||||
| AvoidRepeatCount | Integer defaults to: 0 | How many recently played children to avoid re-selecting. | ||||||||||||||||||
| Children | Array of the type: Either String or MusicContainer | |||||||||||||||||||
| Tags | (Nullable) Map of the following:
Map
| 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. |
Segment
A music container with parallel layers on a shared timeline. EntryMarker is the downbeat and ExitMarker is the loop/transition point.
SegmentMusicContainer with the following properties:
| Key | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Constant value: Segment | This field controls the type, it must be set to the constant value "Segment" to function as this type. | ||||||||||||||||||
| Parent | String | When set this asset will inherit properties from the named asset. When inheriting from another SegmentMusicContainer 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. | ||||||||||||||||||
| Volume | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||||||||||||||
| LoopCount | Integer defaults to: 1 | Number of times to loop. 0 = infinite. | ||||||||||||||||||
| Weight | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Relative weight for random selection when parent is a Random container. | ||||||||||||||||||
| SilenceAfter | (Nullable)
Rangef
| Random silence range (seconds) after this container completes as a child. | ||||||||||||||||||
| ExitSilence | (Nullable)
Rangef
| Random silence range (seconds) when this top-level container is replaced by another. Only valid in top-level containers. | ||||||||||||||||||
| FadeInDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-in duration in seconds. | ||||||||||||||||||
| FadeOutDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-out duration in seconds. | ||||||||||||||||||
| TransitionType | (Nullable) Any one of the following String (defaults to FadeOutFadeIn):
MusicTransitionType
| How a switch into this container behaves when no MusicTransition rule matches, and how a Horizontal parent moves into it. | ||||||||||||||||||
| TransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Per-child override for transition duration. 0 = use parent's default. | ||||||||||||||||||
| ExitAt | (Nullable)
MusicSyncConfig
| When the container playing hands over to this one, on that container's grid. Omit to let TransitionType decide: Immediate hands over at once, Crossfade at the outgoing container's exit marker, FadeOutFadeIn on the next bar. A matched MusicTransition overrides this. | ||||||||||||||||||
| Align | (Nullable) Any one of the following String:
DestinationAlign
| Where this container starts when a transition places it, on its own timeline. Omit to land its entry marker on the handoff. SamePosition carries the outgoing playhead across, which lines up only between arrangements sharing a grid and a loop length, so it suits a Horizontal phase and is rarely right between unrelated containers. Nothing checks that the lengths agree unless a MusicTransition spans the pair. A container seeked mid-file keeps a few milliseconds of fade even under a transition type that asks for none, since cutting into a waveform clicks. A matched MusicTransition overrides this. A phase reached by the previous one ending has no handoff to land against, so it starts at its own beginning. | ||||||||||||||||||
| AlignMarker | (Nullable) String | Marker of this container to align to. Only used with Align: NamedMarker. | ||||||||||||||||||
| PlayToCompletion | Boolean defaults to: false | If true, this container plays to completion before yielding to higher-priority music. | ||||||||||||||||||
| ResumeMemoryDuration | (Nullable) Either Number defaults to: 30.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How long to retain this container's playback state after leaving so a return resumes mid-track instead of restarting. | ||||||||||||||||||
| NameTranslationKey | (Nullable) String | Translation key for the display name of this music container. | ||||||||||||||||||
| AudioCategory | (Nullable) String | Audio category for volume routing. Honoured on any container, and the nearest one up the hierarchy from a playing leaf wins. | ||||||||||||||||||
| Tempo | (Nullable)
TempoSettings
| Tempo and beat grid settings. | ||||||||||||||||||
| StateBindings | (Nullable) Array of the type:
StateBindingConfig
| Subscribe this container to one or more AudioState axes. Per-state volume deltas will be applied to the container and its descendants. | ||||||||||||||||||
| Stingers | (Nullable) Array of the type:
StingerBindingConfig
| Answer music events with stingers. Inherited by descendants. The deepest binding for an event wins, so a parent can give a default that a child overrides. | ||||||||||||||||||
| Layers | Array of the type:
LayerPlacement
| |||||||||||||||||||
| EntryMarker | (Nullable)
BarBeatDuration
| Position of the downbeat on the timeline from segment-time 0. All layers that start at segment-time 0 (no ClipStart) get this much pre-entry material before the downbeat. | ||||||||||||||||||
| ExitMarker | (Nullable)
BarBeatDuration
| Exit position on the timeline from segment-time 0. The active region is [EntryMarker, ExitMarker]. For looping Segments, this is the loop point. For play-once Segments in a Sequence, this is the transition trigger to the next child. | ||||||||||||||||||
| Markers | (Nullable) Array of the type:
MusicMarkerConfig
| Named positions that transition rules and stinger bindings can sync to, counted from the downbeat. | ||||||||||||||||||
| Tags | (Nullable) Map of the following:
Map
| 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. |
Sequence
A music container which plays its tracks in sequence.
SequenceMusicContainer with the following properties:
| Key | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Constant value: Sequence | This field controls the type, it must be set to the constant value "Sequence" to function as this type. | ||||||||||||||||||
| Parent | String | When set this asset will inherit properties from the named asset. When inheriting from another SequenceMusicContainer 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. | ||||||||||||||||||
| Volume | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||||||||||||||
| LoopCount | Integer defaults to: 1 | Number of times to loop. 0 = infinite. | ||||||||||||||||||
| Weight | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Relative weight for random selection when parent is a Random container. | ||||||||||||||||||
| SilenceAfter | (Nullable)
Rangef
| Random silence range (seconds) after this container completes as a child. | ||||||||||||||||||
| ExitSilence | (Nullable)
Rangef
| Random silence range (seconds) when this top-level container is replaced by another. Only valid in top-level containers. | ||||||||||||||||||
| FadeInDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-in duration in seconds. | ||||||||||||||||||
| FadeOutDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-out duration in seconds. | ||||||||||||||||||
| TransitionType | (Nullable) Any one of the following String (defaults to FadeOutFadeIn):
MusicTransitionType
| How a switch into this container behaves when no MusicTransition rule matches, and how a Horizontal parent moves into it. | ||||||||||||||||||
| TransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Per-child override for transition duration. 0 = use parent's default. | ||||||||||||||||||
| ExitAt | (Nullable)
MusicSyncConfig
| When the container playing hands over to this one, on that container's grid. Omit to let TransitionType decide: Immediate hands over at once, Crossfade at the outgoing container's exit marker, FadeOutFadeIn on the next bar. A matched MusicTransition overrides this. | ||||||||||||||||||
| Align | (Nullable) Any one of the following String:
DestinationAlign
| Where this container starts when a transition places it, on its own timeline. Omit to land its entry marker on the handoff. SamePosition carries the outgoing playhead across, which lines up only between arrangements sharing a grid and a loop length, so it suits a Horizontal phase and is rarely right between unrelated containers. Nothing checks that the lengths agree unless a MusicTransition spans the pair. A container seeked mid-file keeps a few milliseconds of fade even under a transition type that asks for none, since cutting into a waveform clicks. A matched MusicTransition overrides this. A phase reached by the previous one ending has no handoff to land against, so it starts at its own beginning. | ||||||||||||||||||
| AlignMarker | (Nullable) String | Marker of this container to align to. Only used with Align: NamedMarker. | ||||||||||||||||||
| PlayToCompletion | Boolean defaults to: false | If true, this container plays to completion before yielding to higher-priority music. | ||||||||||||||||||
| ResumeMemoryDuration | (Nullable) Either Number defaults to: 30.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How long to retain this container's playback state after leaving so a return resumes mid-track instead of restarting. | ||||||||||||||||||
| NameTranslationKey | (Nullable) String | Translation key for the display name of this music container. | ||||||||||||||||||
| AudioCategory | (Nullable) String | Audio category for volume routing. Honoured on any container, and the nearest one up the hierarchy from a playing leaf wins. | ||||||||||||||||||
| Tempo | (Nullable)
TempoSettings
| Tempo and beat grid settings. | ||||||||||||||||||
| StateBindings | (Nullable) Array of the type:
StateBindingConfig
| Subscribe this container to one or more AudioState axes. Per-state volume deltas will be applied to the container and its descendants. | ||||||||||||||||||
| Stingers | (Nullable) Array of the type:
StingerBindingConfig
| Answer music events with stingers. Inherited by descendants. The deepest binding for an event wins, so a parent can give a default that a child overrides. | ||||||||||||||||||
| Children | Array of the type: Either String or MusicContainer | |||||||||||||||||||
| Tags | (Nullable) Map of the following:
Map
| 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. |
SingleTrack
A music container which plays a single audio track. Wrap in a Segment for overlapping loop transitions, pre-entry placement, or vertical layering.
SingleTrackMusicContainer with the following properties:
| Key | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Constant value: SingleTrack | This field controls the type, it must be set to the constant value "SingleTrack" to function as this type. | ||||||||||||||||||
| Parent | String | When set this asset will inherit properties from the named asset. When inheriting from another SingleTrackMusicContainer 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. | ||||||||||||||||||
| Volume | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||||||||||||||
| LoopCount | Integer defaults to: 1 | Number of times to loop. 0 = infinite. | ||||||||||||||||||
| Weight | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Relative weight for random selection when parent is a Random container. | ||||||||||||||||||
| SilenceAfter | (Nullable)
Rangef
| Random silence range (seconds) after this container completes as a child. | ||||||||||||||||||
| ExitSilence | (Nullable)
Rangef
| Random silence range (seconds) when this top-level container is replaced by another. Only valid in top-level containers. | ||||||||||||||||||
| FadeInDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-in duration in seconds. | ||||||||||||||||||
| FadeOutDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Fade-out duration in seconds. | ||||||||||||||||||
| TransitionType | (Nullable) Any one of the following String (defaults to FadeOutFadeIn):
MusicTransitionType
| How a switch into this container behaves when no MusicTransition rule matches, and how a Horizontal parent moves into it. | ||||||||||||||||||
| TransitionDuration | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Per-child override for transition duration. 0 = use parent's default. | ||||||||||||||||||
| ExitAt | (Nullable)
MusicSyncConfig
| When the container playing hands over to this one, on that container's grid. Omit to let TransitionType decide: Immediate hands over at once, Crossfade at the outgoing container's exit marker, FadeOutFadeIn on the next bar. A matched MusicTransition overrides this. | ||||||||||||||||||
| Align | (Nullable) Any one of the following String:
DestinationAlign
| Where this container starts when a transition places it, on its own timeline. Omit to land its entry marker on the handoff. SamePosition carries the outgoing playhead across, which lines up only between arrangements sharing a grid and a loop length, so it suits a Horizontal phase and is rarely right between unrelated containers. Nothing checks that the lengths agree unless a MusicTransition spans the pair. A container seeked mid-file keeps a few milliseconds of fade even under a transition type that asks for none, since cutting into a waveform clicks. A matched MusicTransition overrides this. A phase reached by the previous one ending has no handoff to land against, so it starts at its own beginning. | ||||||||||||||||||
| AlignMarker | (Nullable) String | Marker of this container to align to. Only used with Align: NamedMarker. | ||||||||||||||||||
| PlayToCompletion | Boolean defaults to: false | If true, this container plays to completion before yielding to higher-priority music. | ||||||||||||||||||
| ResumeMemoryDuration | (Nullable) Either Number defaults to: 30.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How long to retain this container's playback state after leaving so a return resumes mid-track instead of restarting. | ||||||||||||||||||
| NameTranslationKey | (Nullable) String | Translation key for the display name of this music container. | ||||||||||||||||||
| AudioCategory | (Nullable) String | Audio category for volume routing. Honoured on any container, and the nearest one up the hierarchy from a playing leaf wins. | ||||||||||||||||||
| Tempo | (Nullable)
TempoSettings
| Tempo and beat grid settings. | ||||||||||||||||||
| StateBindings | (Nullable) Array of the type:
StateBindingConfig
| Subscribe this container to one or more AudioState axes. Per-state volume deltas will be applied to the container and its descendants. | ||||||||||||||||||
| Stingers | (Nullable) Array of the type:
StingerBindingConfig
| Answer music events with stingers. Inherited by descendants. The deepest binding for an event wins, so a parent can give a default that a child overrides. | ||||||||||||||||||
| Track | (Nullable) StringReference to a common asset in the folder:
*.ogg | |||||||||||||||||||
| Tags | (Nullable) Map of the following:
Map
| 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. |
Notes:
Types referenced by this type
SyncPoint
(Nullable) Any one of the following String (defaults to Immediate):
| Name | Description |
|---|---|
"Immediate" | |
"NextBeat" | |
"NextBar" | |
"ExitMarker" | |
"NextMarker" |
StingerShortLead
(Nullable) Any one of the following String (defaults to DropPickup):
| Name | Description |
|---|---|
"DropPickup" | |
"Skip" | |
"Defer" | |
"TrimPickup" |
