Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
WAAPI RPC:
{
"id": "ak.wwise.core.soundbank.generate",
"restrict": [ "userInterface", "commandLine" ],
"description": "Generate a list of SoundBank in memory without writting them to disk, subscribe to ak.wwise.core.soundbank.generated to get SoundBank structure info and the bank data as base64.",
"argsSchema": {
"type": "object",
"description": "Arguments required for this command.",
"properties": {
"soundbanks": {
"type": "array",
"description": "List of SoundBank to generate.",
"items": {
"type": "object",
"description": "SoundBank Info.",
"properties": {
"name": {
"type": "string",
"description": "The name of the SoundBank to generate, a temporary SoundBank will be created if the SoundBank doesn't exists."
},
"events": {
"type": "array",
"description": "List of events to include in this SoundBank.",
"items": {
"$ref": "#/definitions/objectArg",
"description": "The ID (GUID), name, or path of the event to include in the SoundBank."
}
},
"auxBusses": {
"type": "array",
"description": "List of AuxBus to include in this SoundBank.",
"items": {
"$ref": "#/definitions/objectArg",
"description": "The ID (GUID), name, or path of the Auxiliary Bus to include in the SoundBank."
}
},
"inclusions": {
"type": "array",
"description": "List of inclusion type to use for this SoundBank",
"items": {
"type": "string",
"enum": [ "event", "structure", "media" ],
"maxItems": 3
}
}
},
"required": [ "name", "inclusions" ]
}
},
"platforms": {
"type": "array",
"description": "List of platforms to generate.",
"items": {
"type": "string",
"description": "The ID (GUID) or the name of the platforms"
}
},
"languages": {
"type": "array",
"description": "List of languages to generate.",
"items": {
"$ref": "#/definitions/languageArg",
"description": "The ID (GUID) or name of the language."
}
},
"skipLanguages": {
"type": "boolean",
"description": "By default, if you don't specify any languages all languages will be generated. If you set this parameter to true, no localized SoundBank will be generated."
}
},
"required": [ "soundbanks" ],
"additionalProperties": false
},
"resultSchema": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"optionsSchema": {
"type": "object",
"properties": { },
"additionalProperties": false
}
}
Subscription TOPIC:
{
"id": "ak.wwise.core.soundbank.generated",
"restrict": [ "userInterface", "commandLine" ],
"seeAlso": [ "ak.wwise.ui.commands.execute" ],
"description": "Sent when a single SoundBank is generated. This could be sent multiple times during SoundBank generation, for every SoundBank generated and for every platform. To generate SoundBanks, refer to \\ref ak_wwise_ui_commands_execute with one of the SoundBank generation commands. Refer to \\ref globalcommandsids for the list of commands.",
"optionsSchema": {
"type": "object",
"properties": {
"infoFile": {
"type": "boolean",
"description": "Embed the JSON SoundBank info file in the response."
},
"bankData": {
"type": "boolean",
"description": "Embed the base64 SoundBank data in the response."
},
"return": {
"$ref": "#/definitions/returnExpression",
"description": "Data to be returned for the SoundBank generated. Refer to \\ref wobjects_index for more information on the properties available."
}
},
"additionalProperties": false
},
"publishSchema": {
"type": "object",
"properties": {
"soundbank": {
"$ref": "#/definitions/objectReturn",
"description": "The SoundBank generated. Use the return options to obtain specific details."
},
"platform": {
"type": "object",
"description": "The platform for which the SoundBank was generated."
},
"language": {
"type": "object",
"description": "The language for which the SoundBank was generated. Only present when generating a SoundBank for a specific language."
},
"error": {
"type": "string",
"description": "The error message if an error occurred. Only present if an error occurred."
},
"bankData": {
"type": "object",
"description": "SoundBank data object containg the actual data encoded in base64 and the size.",
"properties": {
"data": {
"type": "string",
"description": "Data of the SoundBank encoded in base64."
},
"size": {
"type": "integer",
"description": "Size of the SoundBank data when decoded."
}
}
},
"bankInfo": {
"type": "array",
"description": "All the informations for SoundBank.",
"items": {
"type": "object",
"description": "SoundBank information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the resulting bank encoded in a string."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the resulting SoundBank."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"Language": {
"type": "string",
"description": "The name of the language being used in this soundbank."
},
"ShortName": {
"type": "string",
"description": "The name of the SoundBank."
},
"Path": {
"type": "string",
"description": "The file name of the SoundBank."
},
"IncludedEvents": {
"type": "array",
"description": "All the events included in this SoundBank with their information.",
"items": {
"type": "object",
"description": "Event information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the event."
},
"Name": {
"type": "string",
"description": "Name of the event."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the event."
},
"MaxAttenuation": {
"type": "string",
"description": "The max attenuation of the event as a floating point value."
},
"DurationType": {
"type": "string",
"description": "The kind of duration, possible values: OneShot, Unknown, Infinite, Mixed."
},
"DurationMin": {
"type": "string",
"description": "The minimum value for the duration as a floating point value."
},
"DurationMax": {
"type": "string",
"description": "The maximum value for the duration as a floating point value."
},
"ReferencedStreamedFiles": {
"type": "array",
"description": "List of all streamed files used by this SoundBank or event.",
"items": {
"type": "object",
"description": "Referenced Streamed File entry",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
}
}
}
},
"ExcludedMemoryFiles": {
"type": "array",
"description": "List of excluded media in the SoundBank or event. If you are using prefetch on a streamed file, the prefetch size will be listed here.",
"items": {
"type": "object",
"description": "Excluded Memory File entry",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
},
"PrefetchSize": {
"type": "string",
"description": "Size of bytes of the prefetch size"
}
}
}
},
"IncludedMemoryFiles": {
"type": "array",
"description": "List of included media in the SoundBank or event. If you are using prefetch on a streamed file, the prefetch size will be listed here.",
"items": {
"type": "object",
"description": "Included Memory File entry",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
},
"PrefetchSize": {
"type": "string",
"description": "Size of bytes of the prefetch size"
}
}
}
},
"SwitchContainers": {
"id": "soundBankInfoSwitchContainer",
"type": "array",
"description": "List of association of switch container value to its used media.",
"items": {
"type": "object",
"description": "SwitchContainer entry",
"properties": {
"SwitchValue": {
"$ref": "#/definitions/guid",
"description": "GUID of the switch container value used."
},
"Media" : {
"type": "array",
"description": "List of media used by this switch container value",
"items": {
"type": "object",
"description": "Media entry",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media used."
}
}
}
},
"Children": {
"type": "array",
"description": "Children of this switch container value.",
"items": {
"$ref": "soundBankInfoSwitchContainer",
"description": "Child entry of the switch container"
}
}
}
}
}
}
}
},
"ReferencedStreamedFiles": {
"type": "array",
"description": "List of all streamed files used by this SoundBank or event.",
"items": {
"type": "object",
"description": "Referenced Streamed File entry",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
}
}
}
},
"ExcludedMemoryFiles": {
"type": "array",
"description": "List of excluded media in the SoundBank or event. If you are using prefetch on a streamed file, the prefetch size will be listed here.",
"items": {
"type": "object",
"description": "Exluced Memory File entry.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
},
"PrefetchSize": {
"type": "string",
"description": "Size of bytes of the prefetch size"
}
}
}
},
"IncludedMemoryFiles": {
"type": "array",
"description": "List of included media in the SoundBank or event. If you are using prefetch on a streamed file, the prefetch size will be listed here.",
"items": {
"type": "object",
"description": "Included Memory File entry.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
},
"Language": {
"type": "string",
"description": "Language name used for this media."
},
"ShortName": {
"type": "string",
"description": "File name of the original file."
},
"Path": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
},
"PrefetchSize": {
"type": "string",
"description": "Size of bytes of the prefetch size"
}
}
}
},
"GameParameters": {
"type": "array",
"description": "List of all the Game Parameters/RTPC used in this SoundBank.",
"items": {
"type": "object",
"description": "GameParameter information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Game Parameter."
},
"Name": {
"type": "string",
"description": "Name of the Game Parameter."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the Game Parameter."
}
}
}
},
"Triggers": {
"type": "array",
"description": "List of all Triggers used in this SoundBank.",
"items": {
"type": "object",
"description": "Trigger information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Trigger."
},
"Name": {
"type": "string",
"description": "Name of the Trigger."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the Trigger."
}
}
}
},
"StateGroups": {
"type": "array",
"description": "List of State Group included in this SoundBank.",
"items": {
"type": "object",
"description": "State Group information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the State Group."
},
"Name": {
"type": "string",
"description": "Name of the State Group."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the State Group."
},
"States": {
"type": "array",
"description": "List of State included in this StateGroup.",
"items": {
"type": "object",
"description": "State information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the State."
},
"Name": {
"type": "string",
"description": "Name of the State."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the State."
}
}
}
}
}
}
},
"SwitchGroups": {
"type": "array",
"description": "List of SwitchGroup included in this SoundBank.",
"items": {
"type": "object",
"description": "SwitchGroup information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the SwitchGroup."
},
"Name": {
"type": "string",
"description": "Name of the SwitchGroup."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the SwitchGroup."
},
"Switches": {
"type": "array",
"description": "List of the Switch contained in this SwitchGroup.",
"items": {
"type": "object",
"description": "Switch information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Switch."
},
"Name": {
"type": "string",
"description": "Name of the Switch."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"$ref": "#/definitions/guid",
"description": "GUID of the Switch."
}
}
}
}
}
}
}
}
}
}
},
"required": [ "soundbank", "platform" ],
"additionalProperties": false
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.