This section describes the types of objects handled by scripts and their corresponding names.
In the script, you use a string that represents the internal ID of the project's data structure as an object.
For this reason, empty objects are represented by an empty string.
However, for functions that take objects as input arguments, setting None
will make them behave the same as if an empty string was given.
Object type and name
Project settings, user settings, global settings
Type | Name |
Project Settings | Project |
User Settings | UserSettings |
Global Settings Folder | GlobalFolder |
Target Config Folder | TargetConfigFolder |
Target Config (PC) | TargetConfigPc |
Target Config (PS4/PS5) | TargetConfigPs4 |
Target Config (Xbox One/Series) | TargetConfigXboxOne |
Target Config (Switch) | TargetConfigSwitch |
Target Config (iPhone) | TargetConfigiPhone |
Target Config (Android) | TargetConfigAndroid |
Target Config (WebGL) | TargetConfigWebGl |
Target Config (Public) | TargetConfigPublic |
LanguageSettingsFolder | LanguageSettingsFolder |
Language Settings | LanguageSettings |
MixerFolder | MixerFolder |
Mixer | Mixer |
MixerSnapshot | MixerSnapshot |
Bus | Bus |
Master Out Bus | BusMaster |
BusMap | BusMap |
Category Folder | CategoryFolder |
CategoryGroup | CategoryGroup |
Category | Category |
GameVariableFolder | GameVariableFolder |
GameVariable | GameVariable |
SelectorFolder | SelectorFolder |
Selector | Selector |
SelectorLabel | SelectorLabel |
ReactFolder | ReactFolder |
REACT | React |
VoiceLimitGroupFolder | VoiceLimitGroupFolder |
VoiceLimitGroup | VoiceLimitGroup |
AISAC Control Folder | AisacControlFolder |
AISAC Control | AisacControl |
Global AISAC Folder | GlobalAisacFolder |
AISAC
Type | Name |
AISAC | Aisac |
AISACGraph | AisacGraph |
AISAC Graph Point | AisacPoint |
Work unit tree
Type | Name |
WorkUnitFolder | WorkUnitFolder |
WorkUnit | WorkUnit |
ReferenceAisacFolder | ReferenceAisacFolder |
CueSheetRootFolder | CueSheetRootFolder |
CueSheetFolder | CueSheetFolder |
CueSheet | CueSheet |
CueFolder | CueFolder |
Private Cue Folder | PrivateCueFolder |
Cue | Cue |
LoopMarker | LoopMarker |
Sequence start marker | StartMarker |
Sequence stop marker | EndMarker |
CallbackMarker | CallbackMarker |
Sequence end marker for REACT | ReactEndMarker |
Automation | Automation |
AutomationPoint | AutomationPoint |
Track | Track |
WaveformRegion | WaveformRegion |
SubSequence | SubSequence |
(Internal) Cue | CueLink |
ExternalCueLink | ExternalCueLink |
ActionTrack | ActionTrack |
Playback start action | ActionStart |
Stop Start Action | ActionStop |
PauseAction | ActionPause |
Resume action | ActionResume |
Mute action | ActionMute |
Set playback parameters action | ActionSetPlaybackParameter |
Set Selector Label Action | ActionSetSelectorLabel |
Player ActionTrack | PlayerActionTrack |
Player Fader Action | ActionPlayerFader |
AISAC Link | AisacLink |
Block | Block |
BeatSync | BeatSync |
Material Tree
Type | Name |
MaterialInfo | MaterialInfo |
MaterialRootFolder | MaterialRootFolder |
MaterialSubFolder | MaterialSubFolder |
Material | Material |
Bus effect type and name
Type | Name |
BandpassFilter | BandpassFilter |
BiquadFilter | BiquadFilter |
Limiter | Limiter |
Compressor | Compressor |
Delay | Delay |
Echo | Echo |
PitchShifter | PitchShifter |
Reverb | Reverb |
3 Band EQ | 3BandEQ |
32 Band EQ | 32BandEQ |
Chorus | Chorus |
Flanger | Flanger |
Distortion | Distortion |
| Amplitude Analyzer | | Surrounder | Surrounder | | I3DL2Reverb | I3DL2Reverb | | Multi tap delay | MultiTapDelay | | Matrix | Matrix | | Phaser | Phaser | | BitCrusher | BitCrusher | | HeadphoneVirtualSurround | HeadphoneVirtualSurround |
AISAC graph automation playback parameter setting action types and names
Graph Type | Name | Value Range | (Action) Speed to Goal |
Volume | Volume | 0.0 - 2.0 | 0.01 - 10 |
Pitch | Pitch | -3600 - 3600 "cent" | 1 - 4800 |
Voice Priority | Priority | -255 - 255 | AISAC Graph Automation Only |
PreDelayTime | PreDelayTime | 0 - 10000 "ms" | AISAC Graph Automation Only |
PlaybackRate | PlaybackRate | 0.0 - 4.0 | 0.01 - 10 |
Logarithmically scaled normalized value of the bandpass filter high cutoff frequency | BandPassHigh | 0.0 - 1.0 | 0.01 - 10 |
Logarithmically scaled normalized value of the bandpass filter low cutoff frequency | BandPassLow | 0.0 - 1.0 | 0.01 - 10 |
Logarithmic scale normalized value of biquad filter cutoff frequency | BiquadFreq | -1.0 - 1.0 | 0.01 - 10 |
Biquad filter Q value | BiquadQ | -10.0 - 10.0 | 0.01 - 10 |
Biquad filter gain | BiquadGain | 0.0 - 10.0 | 0.01 - 10 |
Pan angle | PanAngle | -180 - 180 "deg" | 1 - 360 |
Pan Volume | PanVolume | 0.0 - 1.0 | 0.01 - 10 |
Pan interior distance | PanInteriorDistance | 0.0 - 1.0 | 0.01 - 10 |
PanCenter | PanCenter | 0.0 - 1.0 | 0.01 - 10 |
Pan LFE | PanLFE | 0.0 - 1.0 | 0.01 - 10 |
Pan Wideness | PanWideness | 0.0 - 1.0 | 0.01 - 10 |
Bread Spread | Spread | 0.0 - 1.0 | 0.01 - 10 |
Envelope attack time | EgAttackTimeMs | 0 - 2000 | AISAC graph automation only |
Envelope release time | EgReleaseTimeMs | 0 - 10000 | 1 - 10000 |
Amount of send to the first bus | BusSendLevel1 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the second bus | BusSendLevel2 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the third bus | BusSendLevel3 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the 4th bus | BusSendLevel4 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the 5th bus | BusSendLevel5 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the 6th bus | BusSendLevel6 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the 7th bus | BusSendLevel7 | 0.0 - 1.0 | 0.01 - 10 |
Amount of send to the 8th bus | BusSendLevel8 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 0 | AisacControl0 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 1 | AisacControl1 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 2 | AisacControl2 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 3 | AisacControl3 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 4 | AisacControl4 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 5 | AisacControl5 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 6 | AisacControl6 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 7 | AisacControl7 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 8 | AisacControl8 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 9 | AisacControl9 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 10 | AisacControl10 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 11 | AisacControl11 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 12 | AisacControl12 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 13 | AisacControl13 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 14 | AisacControl14 | 0.0 - 1.0 | 0.01 - 10 |
Aisac control 15 | AisacControl15 | 0.0 - 1.0 | 0.01 - 10 |