Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17
UserProjectSettings
  • Plugin ID: 51
  • Class ID: 3342352

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
AutoSoundBankAllEventsAuto SoundBank Generation - All EventsboolfalseNonefalseNonefalse
AutoSoundBankEnabledEnable Auto SoundBank GenerationboolfalseNonetrueNonefalse
ConversionConversion SettingsReference 

Possible types :

Conversion

true  
ConvertExternalSourcesConvert External SourcesbooltrueNonetrueNonefalse
CopyLooseStreamedMediaCopy Loose/Streamed Media FilesbooltrueNonetrueNonefalse
DefaultSoundVolumeDefaultSoundVolumeReal640[ -200 , 200 ]falseNonefalse
EventActionNamePositionEvent Action Name Positionint160

Possible values :

Value Display Name
0prefix
1suffix

trueNonefalse
EventCreationSettingsOverrideEvent Creation Settings OverrideboolfalseNonetrueNonefalse
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
ExternalSourcesOverrideInputPathExternal Sources Override Input PathboolfalseNonetrueNonefalse
ExternalSourcesOverrideOutputPathExternal Sources Override Output PathboolfalseNonetrueNonefalse
GenerateMainSoundBankGenerate Main SoundBankbooltrueNonetrueNonefalse
GenerateMultipleBanksGenerate Multiple BanksboolfalseNonetrueNonefalse
GenerateSoundBankJSONGenerate SoundBank JSONboolfalseNonetrueNonefalse
GenerateSoundBankXMLGenerate SoundBank XMLbooltrueNonetrueNonefalse
MediaAutoBankSubFoldersSub-folders for Media and Auto-generated Bank FilesboolfalseNonetrueNonefalse
OverrideConversionOverride Conversion SettingsboolfalseNonetrueNonefalse
PostGenerateStepUserOverridePost-Generate Step User OverrideboolfalseNonetrueNonefalse
PreGenerateStepUserOverridePre-Generate Step User OverrideboolfalseNonetrueNonefalse
RemoveUnusedGeneratedFilesRemove Unused Generated FilesbooltrueNonetrueNonefalse
SettingsUserOverrideSettings User OverrideboolfalseNonetrueNonefalse
SoundBankAllowExceedingSBSoundBank Allow ExceedingSBboolfalseNonetrueNonefalse
SoundBankDefinitionFileFormatSoundBankDefinitionFileFormatint160

Possible values :

Value Display Name
0
1

falseNonefalse
SoundBankGenerateDefinitionFileSoundBank Generate Definition FilebooltrueNonetrueNonefalse
SoundBankGenerateEstimatedDurationSoundBank Generate Estimated DurationboolfalseNonetrueNonefalse
SoundBankGenerateHeaderFileSoundBank Generate Header FileboolfalseNonetrueNonefalse
SoundBankGenerateMaxAttenuationInfoSoundBank Generate Max Attenuation InfoboolfalseNonetrueNonefalse
SoundBankGeneratePrintGUIDSoundBank Generate Print GUIDboolfalseNonetrueNonefalse
SoundBankGeneratePrintPathSoundBank Generate Print PathboolfalseNonetrueNonefalse
SoundBankGenerateReadableFileSoundBankGenerateReadableFileboolfalseNonefalseNonefalse
SoundBankHeaderFilePathSoundBank Header File Pathstring NonetrueNonefalse
SoundBankIncludeSoundbankNamesStringsSoundBank Include Soundbank Names StringsbooltrueNonetrueNonefalse
SoundBankPathUserOverrideSoundBank Path User OverrideboolfalseNonetrueNonefalse
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

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