Version
menu_open
Wwise SDK 2024.1.0
Project
  • Plugin ID: 3
  • Class ID: 196624

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

Properties, References, Lists

NameDisplay NameTypeDefaultRestrictionIs VisibleSupported RTPC TypeSupports Link/Unlink
AlwaysSaveMediaIDsFileAlways persist the media IDs file on project saveboolfalseNonefalseNonefalse
AutoDetectFFTWindowSizeAuto Detect FFT Window Sizeint16512

Possible values :

Value Display Name
6464
128128
256256
512512
10241024
20482048

trueNonefalse
AutoDetectThresholdHighAuto Detect Threshold HighReal64-50[ -96.3 , 0 ]trueNonefalse
AutoDetectThresholdLowAuto Detect Threshold LowReal64-30[ -96.3 , 0 ]trueNonefalse
AutoDetectThresholdMediumAuto Detect Threshold MediumReal64-40[ -96.3 , 0 ]trueNonefalse
AutoSoundBankAllEventsAuto SoundBank Generation - All EventsboolfalseNonefalseNonefalse
AutoSoundBankEnabledEnable Auto SoundBank GenerationboolfalseNonetrueNonefalse
ColorColorint160[ 0 , 26 ]trueNonefalse
CommPortDiscoveryBroadcastCommunication Port Discovery BroadcastUint1624024[ 1 , 65535 ]trueNonefalse
CommPortDiscoveryResponseCommunication Port Discovery ResponseUint160[ 0 , 65535 ]trueNonefalse
CommSerialPortBaseCommunication Serial Port BaseUint168[ 0 , 12 ]trueNonefalse
CopyLooseStreamedMediaCopy Loose/Streamed Media FilesbooltrueNonetrueNonefalse
DefaultLanguageReference LanguagestringEnglish(US)NonetrueNonefalse
EventActionNamePositionEvent Action Name Positionint160

Possible values :

Value Display Name
0prefix
1suffix

trueNonefalse
EventNameCaseTypeEvent Name Case Typeint160

Possible values :

Value Display Name
0all lowercase
1all uppercase

trueNonefalse
EventNameModifyCaseEvent Name Modify CaseboolfalseNonetrueNonefalse
ExternalSourcesInputPathExternal Sources Input Pathstring NonetrueNonetrue
ExternalSourcesOutputPathExternal Sources Output Pathstring NonetrueNonetrue
FilterBehaviorFilter Behaviorint160

Possible values :

Value Display Name
0Sum all values (default)
1Use highest value

trueNonefalse
GarbageCollectWaveAnalysisGarbageCollectWaveAnalysisbooltrueNonefalseNonefalse
GenerateMainSoundBankGenerate Main SoundBankboolfalseNonetrueNonefalse
GenerateMultipleBanksGenerate Multiple BanksbooltrueNonetrueNonefalse
GenerateSoundBankJSONGenerate SoundBank JSONbooltrueNonetrueNonefalse
GenerateSoundBankXMLGenerate SoundBank XMLboolfalseNonetrueNonefalse
GlobalVoiceInstancesLimitGlobal Voice Instances Limitint16256[ 1 , 10000 ]trueNonetrue
LicenseKeyLicenseKeystring NonefalseNonefalse
LineEndingLine EndingUint160

Possible values :

Value Display Name
0LF (default)
1CRLF

trueNonefalse
MaxDangerousVirtualVoicesMax Dangerous Virtual VoicesUint3250NonetrueNonefalse
MaxMessagesPerMessageIdMax Messages Per Message IdUint32100NonetrueNonefalse
MediaAutoBankSubFoldersSub-folders for Media and Auto-generated Bank FilesboolfalseNonetrueNonefalse
MediaIDsInSingleFilePersist media IDs in single fileboolfalseNonefalseNonefalse
OverrideColorOverride ColorboolfalseNonetrueNonefalse
RemoveUnusedGeneratedFilesRemove Unused Generated FilesbooltrueNonetrueNonefalse
SoundBankAllowExceedingSBSoundBank Allow ExceedingSBboolfalseNonetrueNonefalse
SoundBankDefinitionFileFormatSoundBankDefinitionFileFormatint160

Possible values :

Value Display Name
0
1

falseNonefalse
SoundBankGenerateDefinitionFileSoundBank Generate Definition FilebooltrueNonetrueNonefalse
SoundBankGenerateEstimatedDurationSoundBank Generate Estimated DurationbooltrueNonetrueNonefalse
SoundBankGenerateHeaderFileSoundBank Generate Header FileboolfalseNonetrueNonefalse
SoundBankGenerateMaxAttenuationInfoSoundBank Generate Max Attenuation InfobooltrueNonetrueNonefalse
SoundBankGeneratePrintGUIDSoundBank Generate Print GUIDbooltrueNonetrueNonefalse
SoundBankGeneratePrintPathSoundBank Generate Print PathbooltrueNonetrueNonefalse
SoundBankGenerateReadableFileSoundBankGenerateReadableFileboolfalseNonefalseNonefalse
SoundBankHeaderFilePathSoundBank Header File Pathstring NonetrueNonefalse
SoundBankIncludeSoundbankNamesStringsSoundBank Include Soundbank Names StringsbooltrueNonetrueNonefalse
SoundBankPathsSoundBank Pathsstring NonetrueNonetrue
SoundBankPostGenerateCustomCmdDescriptionSoundBank Post-Generate Custom Command Descriptionstring NonetrueNonetrue
SoundBankPostGenerateCustomCmdLinesSoundBank Post-Generate Custom Command Linesstring NonetrueNonetrue
SoundBankPreGenerateCustomCmdDescriptionSoundBank Pre-Generate Custom Command Descriptionstring NonetrueNonetrue
SoundBankPreGenerateCustomCmdLinesSoundBank Pre-Generate Custom Command Linesstring NonetrueNonetrue
SoundBankUpdateAudioFilesSoundBank Update Audio FilesboolfalseNonetrueNonefalse
SourceControlGeneratedFilesGenerated Files in Source ControlboolfalseNonetrueNonefalse
UseActionNameForEventUse Action Name For EventbooltrueNonetrueNonefalse
UseDefaultLanguageUse Default LanguagebooltrueNonetrueNonefalse
UseMaxDangerousVirtualVoicesUse Max Dangerous Virtual VoicesbooltrueNonetrueNonefalse
UseMaxMessagesPerMessageIdUse Max Messages Per Message IdbooltrueNonetrueNonefalse
VolumeThresholdVolume ThresholdReal64-80[ -96 , 0 ]trueNonetrue
WwiseConsoleLoadUserSettingsLoad user project settings when running WwiseConsoleboolfalseNonefalseNonefalse
WwiseVersionWhenCreatedWwise Version When Createdstring NonetrueNonefalse

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise