Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.9
Project
  • Plugin ID: 3
  • Class ID: 196624

Refer to ak.wwise.core.object.setProperty and ak.wwise.core.object.setReference to set properties and references with WAAPI. Also refer to Querying the Wwise Project to learn how to query properties and references.

Properties

Name Display Name Type Default Restriction Is Visible Supported RTPC Type Supports Link/Unlink
AlwaysSaveMediaIDsFile Always persist the media IDs file on project save bool false None false None false
AutoDetectFFTWindowSize Auto Detect FFT Window Size int16 512

Possible values :

Value Display Name
64 64
128 128
256 256
512 512
1024 1024
2048 2048

true None false
AutoDetectThresholdHigh Auto Detect Threshold High Real64 -50 [ -96.3 , 0 ] true None false
AutoDetectThresholdLow Auto Detect Threshold Low Real64 -30 [ -96.3 , 0 ] true None false
AutoDetectThresholdMedium Auto Detect Threshold Medium Real64 -40 [ -96.3 , 0 ] true None false
Color Color int16 0 [ 0 , 26 ] true None false
CommPortDiscoveryBroadcast Communication Port Discovery Broadcast Uint16 24024 [ 1 , 65535 ] true None false
CommPortDiscoveryResponse Communication Port Discovery Response Uint16 0 [ 0 , 65535 ] true None false
CommSerialPortBase Communication Serial Port Base Uint16 8 [ 0 , 12 ] true None false
DefaultLanguage Reference Language string English(US) None true None false
EventActionNamePosition Event Action Name Position int16 0

Possible values :

Value Display Name
0 prefix
1 suffix

true None false
EventNameCaseType Event Name Case Type int16 0

Possible values :

Value Display Name
0 all lowercase
1 all uppercase

true None false
EventNameModifyCase Event Name Modify Case bool false None true None false
ExternalSourcesInputPath External Sources Input Path string   None true None true
ExternalSourcesOutputPath External Sources Output Path string   None true None true
FrequencyWeighting Frequency Weighting int16 1

Possible values :

Value Display Name
0 None
1 K-weightings
2 A-weightings

true None false
GenerateMainSoundBank Generate Main SoundBank bool true None true None false
GenerateMultipleBanks Generate Multiple Banks bool false None true None false
GenerateSoundBankJSON Generate SoundBank JSON bool false None true None false
GenerateSoundBankXML Generate SoundBank XML bool true None true None false
GlobalVoiceInstancesLimit Global Voice Instances Limit int16 256 [ 1 , 10000 ] true None true
LicenseKey LicenseKey string   None false None false
MaxDangerousVirtualVoices Max Dangerous Virtual Voices Uint32 50 None true None false
MaxMessagesPerMessageId Max Messages Per Message Id Uint32 100 None true None false
MediaIDsInSingleFile Persist media IDs in single file bool false None false None false
OverrideColor Override Color bool false None true None false
SoundBankAllowExceedingSB SoundBank Allow ExceedingSB bool false None true None false
SoundBankDefinitionFileFormat SoundBankDefinitionFileFormat int16 0

Possible values :

Value Display Name
0
1

false None false
SoundBankGenerateDefinitionFile SoundBank Generate Definition File bool true None true None false
SoundBankGenerateEstimatedDuration SoundBank Generate Estimated Duration bool false None true None false
SoundBankGenerateHeaderFile SoundBank Generate Header File bool false None true None false
SoundBankGenerateMaxAttenuationInfo SoundBank Generate Max Attenuation Info bool false None true None false
SoundBankGeneratePrintGUID SoundBank Generate Print GUID bool false None true None false
SoundBankGenerateReadableFile SoundBankGenerateReadableFile bool false None false None false
SoundBankHeaderFilePath SoundBank Header File Path string   None true None false
SoundBankIncludeSoundbankNamesStrings SoundBank Include Soundbank Names Strings bool true None true None false
SoundBankPaths SoundBank Paths string   None true None true
SoundBankPostGenerateCustomCmdDescription SoundBank Post-Generate Custom Command Description string   None true None true
SoundBankPostGenerateCustomCmdLines SoundBank Post-Generate Custom Command Lines string   None true None true
SoundBankPreGenerateCustomCmdDescription SoundBank Pre-Generate Custom Command Description string   None true None true
SoundBankPreGenerateCustomCmdLines SoundBank Pre-Generate Custom Command Lines string   None true None true
SoundBankUpdateAudioFiles SoundBank Update Audio Files bool false None true None false
UseActionNameForEvent Use Action Name For Event bool true None true None false
UseDefaultLanguage Use Default Language bool true None true None false
UseMaxDangerousVirtualVoices Use Max Dangerous Virtual Voices bool true None true None false
UseMaxMessagesPerMessageId Use Max Messages Per Message Id bool true None true None false
VolumeThreshold Volume Threshold Real64 -80 [ -96 , 0 ] true None true
WwiseVersionWhenCreated Wwise Version When Created string   None true None false