"description": "Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override. Refer to \\ref wobjects_index ."
}
],
"description": "A return expression."
},
"type": "array",
"description": "Specifies what is being returned for every object. Refer to \\ref wobjects_index for more information on the properties and references available.\\n The array of return expressions defines which elements of the Wwise object will be returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or Pitch."
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
}
],
"description": "Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @@ specifies the value of the property using the source of override. Refer to \\ref wobjects_index for more information on the properties and references for all types available."
}
},
"type": "object",
"description": "A Wwise object. Use the return options to specify which property is required.",
"properties": {
"soundbank:bnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"objectSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
},
"audioSource:maxDurationSource": {
"type": "object",
"description": "Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"description": "The ID (GUID) of the audio source object with longest duration.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"trimmedDuration": {
"type": "number",
"description": "The duration in seconds of the longest trimmed source."
}
}
},
"music:transitionRoot": {
"type": "object",
"description": "The music transition root containing all other music transitions recursively.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"workunit:type": {
"enum": [
"folder",
"rootFile",
"nestedFile"
],
"type": "string",
"description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders will have the workunit:type \"folder\"."
},
"owner": {
"type": "object",
"description": "The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"mediaSize": {
"type": "integer",
"description": "The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate."
},
"sound:originalWavFilePath": {
"type": "string",
"description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"structureSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object and all of its children will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"category": {
"type": "string",
"description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
},
"switchContainerChild:context": {
"type": "object",
"description": "The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"totalSize": {
"type": "integer",
"description": "The amount of space (in bytes) this object and all of its children will take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate."
},
"type": {
"type": "string",
"description": "The type of the object. Refer to \\ref wobjects_index for more information on the types available."
},
"workunit:isDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"isPlayable": {
"type": "boolean",
"description": "True if the object can be played in Transport."
},
"audioSource:trimValues": {
"type": "object",
"description": "Range of time for which the audio source is trimmed.",
"properties": {
"trimBegin": {
"type": "number",
"description": "The time value in seconds of the start trim."
},
"trimEnd": {
"type": "number",
"description": "The time value in seconds of the end trim."
}
}
},
"audioSource:maxRadiusAttenuation": {
"type": "object",
"description": "Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
"description": "The ID (GUID) of the attenuation object with the largest radius.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"parent": {
"type": "object",
"description": "The parent of the object in the hierarchy.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"filePath": {
"type": "string",
"description": "The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"workunit:isDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved."
},
"workunit": {
"type": "object",
"description": "The parent Work Unit containing the object. The 'id' and the 'name' will be returned.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"shortId": {
"type": "integer",
"description": "The short ID of the object."
},
"sound:convertedWemFilePath": {
"type": "string",
"description": "Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"audioSource:playbackDuration": {
"type": "object",
"description": "The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "The minimum possible time playback can take."
},
"playbackDurationMax": {
"type": "number",
"description": "The maximum possible time playback can take."
},
"playbackDurationType": {
"type": "string",
"description": "The type of duration."
}
}
},
"path": {
"type": "string",
"description": "The path of the object from the project root. Ex: '\\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\Sound1'"
},
"music:playlistRoot": {
"type": "object",
"description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.",
"description": "The ID (GUID) of the Language object to which the Audio Source object is associated.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the Language object to which the Audio Source object is associated."
}
}
},
"notes": {
"type": "string",
"description": "The notes of the object."
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object."
}
}
},
"voiceReturnOptions": {
"items": {
"enum": [
"pipelineID",
"playingID",
"soundID",
"gameObjectID",
"gameObjectName",
"objectGUID",
"objectName",
"playTargetID",
"playTargetGUID",
"playTargetName",
"baseVolume",
"gameAuxSendVolume",
"envelope",
"normalizationGain",
"lowPassFilter",
"highPassFilter",
"priority",
"isStarted",
"isVirtual",
"isForcedVirtual"
],
"type": "string",
"description": "Specifies one of the defined members for a voice pipeline structure."
},
"type": "array",
"description": "An array of options for the playing voices."
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01"
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"pattern": "^\\\\",
"type": "string",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
}
]
},
"uint16": {
"minimum": 0,
"type": "integer",
"description": "Unsigned Integer 16-bit.",
"maximum": 65535
},
"logCentralChannel": {
"enum": [
"soundbankGenerate",
"conversion",
"copyPlatformSettings",
"waapi",
"projectLoad",
"general"
],
"type": "string",
"description": "The log channel."
},
"objectPathArg": {
"pattern": "^\\\\",
"type": "string",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
},
"logCentralItem": {
"additionalProperties": false,
"required": [
"severity",
"time",
"messageId",
"message"
],
"type": "object",
"description": "A log entry.",
"properties": {
"severity": {
"enum": [
"Message",
"Warning",
"Error",
"Fatal Error"
],
"type": "string",
"description": "Message: not impacting the integrity of the current operation. \nWarning: potentially impacting the integrity of the current operation. \nError: impacting the integrity of the current operation. \nFatal Error: impacting the completion of the current operation."
},
"parameters": {
"items": {
"type": "string",
"description": "A parameter of the log entry. Normally an object name."
},
"type": "array",
"description": "An array of parameters in the log item. Not present when no parameter."
},
"time": {
"type": "integer",
"description": "Number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock."
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
}
],
"description": "Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @@ specifies the value of the property using the source of override. Refer to \\ref wobjects_index for more information on the properties and references for all types available."
}
},
"type": "object",
"description": "The platform for which the log item was reported.\\n A Wwise object. Use the return options to specify which property is required.",
"properties": {
"soundbank:bnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"objectSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
},
"audioSource:maxDurationSource": {
"type": "object",
"description": "Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"description": "The ID (GUID) of the audio source object with longest duration.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"trimmedDuration": {
"type": "number",
"description": "The duration in seconds of the longest trimmed source."
}
}
},
"music:transitionRoot": {
"type": "object",
"description": "The music transition root containing all other music transitions recursively.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"workunit:type": {
"enum": [
"folder",
"rootFile",
"nestedFile"
],
"type": "string",
"description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders will have the workunit:type \"folder\"."
},
"owner": {
"type": "object",
"description": "The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"mediaSize": {
"type": "integer",
"description": "The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate."
},
"sound:originalWavFilePath": {
"type": "string",
"description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"structureSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object and all of its children will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"category": {
"type": "string",
"description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
},
"switchContainerChild:context": {
"type": "object",
"description": "The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"totalSize": {
"type": "integer",
"description": "The amount of space (in bytes) this object and all of its children will take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate."
},
"type": {
"type": "string",
"description": "The type of the object. Refer to \\ref wobjects_index for more information on the types available."
},
"workunit:isDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"isPlayable": {
"type": "boolean",
"description": "True if the object can be played in Transport."
},
"audioSource:trimValues": {
"type": "object",
"description": "Range of time for which the audio source is trimmed.",
"properties": {
"trimBegin": {
"type": "number",
"description": "The time value in seconds of the start trim."
},
"trimEnd": {
"type": "number",
"description": "The time value in seconds of the end trim."
}
}
},
"audioSource:maxRadiusAttenuation": {
"type": "object",
"description": "Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
"description": "The ID (GUID) of the attenuation object with the largest radius.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"parent": {
"type": "object",
"description": "The parent of the object in the hierarchy.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"filePath": {
"type": "string",
"description": "The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"workunit:isDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved."
},
"workunit": {
"type": "object",
"description": "The parent Work Unit containing the object. The 'id' and the 'name' will be returned.",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
},
"shortId": {
"type": "integer",
"description": "The short ID of the object."
},
"sound:convertedWemFilePath": {
"type": "string",
"description": "Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"audioSource:playbackDuration": {
"type": "object",
"description": "The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "The minimum possible time playback can take."
},
"playbackDurationMax": {
"type": "number",
"description": "The maximum possible time playback can take."
},
"playbackDurationType": {
"type": "string",
"description": "The type of duration."
}
}
},
"path": {
"type": "string",
"description": "The path of the object from the project root. Ex: '\\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\Sound1'"
},
"music:playlistRoot": {
"type": "object",
"description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.",
"description": "The ID (GUID) of the Language object to which the Audio Source object is associated.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the Language object to which the Audio Source object is associated."
}
}
},
"notes": {
"type": "string",
"description": "The notes of the object."
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object."
}
}
},
"messageId": {
"type": "string",
"description": "The message ID for the log item."
},
"message": {
"type": "string",
"description": "The description message of the log item."
}
}
},
"profilerCursor": {
"enum": [
"user",
"capture"
],
"type": "string",
"description": "Identify one of the global profiler cursors."
},
"returnExpression": {
"items": {
"anyOf": [
{
"enum": [
"id",
"name",
"notes",
"type",
"shortId",
"classId",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"totalSize",
"mediaSize",
"objectSize",
"structureSize",
"sound:convertedWemFilePath",
"sound:originalWavFilePath",
"soundbank:bnkFilePath",
"music:transitionRoot",
"music:playlistRoot",
"audioSource:playbackDuration",
"audioSource:maxDurationSource",
"audioSource:trimValues",
"audioSource:maxRadiusAttenuation",
"audioSource:language",
"workunit:isDefault",
"workunit:type",
"workunit:isDirty",
"switchContainerChild:context"
],
"type": "string",
"description": "Specifies one or many of the built-in accessors for Wwise objects."
"description": "Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override. Refer to \\ref wobjects_index ."
}
],
"description": "A return expression."
},
"type": "array",
"description": "The array of return expressions defines which elements of the Wwise object will be returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or Pitch."
},
"uint32": {
"minimum": 0,
"type": "integer",
"description": "Unsigned Integer 32-bit.",
"maximum": 4294967295
},
"int32": {
"minimum": -2147483648,
"type": "integer",
"description": "Integer 32-bit.",
"maximum": 2147483647
},
"voiceContributionsObject": {
"additionalProperties": false,
"type": "object",
"description": "Identify a Voice Inspector contribution.",
"properties": {
"name": {
"type": "string",
"description": "The name of the contribution."
},
"parameters": {
"items": {
"additionalProperties": false,
"type": "object",
"description": "A contribution parameter.",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the parameter to affect the voice."
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"gameObject": {
"minimum": 0,
"type": "integer",
"description": "A game object ID, unsigned integer 64-bit.",
"maximum": 18446744073709551615
},
"shortId": {
"additionalProperties": false,
"required": [
"shortId",
"type"
],
"type": "object",
"description": "A Wwise object short ID with its associated type.",
"properties": {
"shortId": {
"minimum": 0,
"type": "integer",
"description": "The short ID of the object.\\n Unsigned Integer 32-bit.",
"maximum": 4294967295
},
"type": {
"minimum": 1,
"type": "integer",
"description": "The type of object for the short ID. Refer to \\ref wobjects_index for object types."
}
}
},
"uniqueName": {
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$",
"type": "string",
"description": "The name of the object."
},
"addOnsCommands": {
"items": {
"additionalProperties": false,
"required": [
"id",
"displayName"
],
"type": "object",
"description": "Specify a command add-on.",
"properties": {
"displayName": {
"type": "string",
"description": "Defines the name displayed in the user interface."
},
"contextMenu": {
"additionalProperties": false,
"type": "object",
"description": "If present, specify how the command is added to Wwise context menus. If empty, no context menu is added.",
"properties": {
"visibleFor": {
"type": "string",
"description": "Defines a comma-separated list of the object types for which the item is visible. Refer to \\ref wobjects_index for the list of types supported. If empty, any type is allowed."
},
"basePath": {
"type": "string",
"description": "Defines a forward-separated path for the parent sub menus. If empty, the menu is insert at first level."
},
"enabledFor": {
"type": "string",
"description": "Defines a comma-separated list of the object types for which the item is enabled. Refer to \\ref wobjects_index for the list of types supported. If empty, any type is allowed."
}
}
},
"args": {
"type": "string",
"description": "Defines the arguments. Refer to documentation for the built-in variables supported. Note that in case of multiple selection, the variables are expanded based on the startMode field."
},
"mainMenu": {
"additionalProperties": false,
"required": [
"basePath"
],
"type": "object",
"description": "If present, specify how the command is added to Wwise main menus. If empty, no main menu entry is added.",
"properties": {
"basePath": {
"type": "string",
"description": "Defines a forward-separated path for the parent sub menus. It must at least define one level, which is associated to the top menu."
}
}
},
"cwd": {
"type": "string",
"description": "Defines the current working directory to execute the program."
},
"program": {
"type": "string",
"description": "Defines the program or script to run when the command is executed. Arguments are specified in 'args'."
},
"defaultShortcut": {
"type": "string",
"description": "Defines the shortcut to use by default for this command. If the shortcut conflicts, it won't be used. This shortcut can be changed in the Keyboard Shortcut Manager."
},
"startMode": {
"enum": [
"SingleSelectionSingleProcess",
"MultipleSelectionSingleProcessSpaceSeparated",
"MultipleSelectionMultipleProcesses"
],
"type": "string",
"description": "Specifies how to expand variables in the arguments field in case of multiple selection in Wwise user interface. SingleSelectionSingleProcess: only support single selection, will start the program once. MultipleSelectionSingleProcessSpaceSeparated: program is started once with variables expanded to space separated arguments, each enclosed in double-quotes. MultipleSelectionMultipleProcesses: program is started once per item selected, in parallel. Each running instance receives one selected item."
},
"id": {
"type": "string",
"description": "Defines a human readable unique ID for the command. To reduce risk of ID conflicts, please use a concatenation of the author name, the product name and the command name."
}
}
},
"type": "array",
"description": "An array of command add-ons."
},
"int8": {
"minimum": -128,
"type": "integer",
"description": "Integer 8-bit.",
"maximum": 127
},
"uint64": {
"minimum": 0,
"type": "integer",
"description": "Unsigned Integer 64-bit.",
"maximum": 18446744073709551615
},
"busReturn": {
"type": "object",
"description": "A mixing bus object. Use the return options to specify which property is required.",
"properties": {
"objectName": {
"type": "string",
"description": "Object Name corresponding to the bus."
},
"gameObjectID": {
"minimum": 0,
"type": "integer",
"description": "Game Object ID corresponding to the voice.\\n Unsigned Integer 64-bit.",
"maximum": 18446744073709551615
},
"pipelineID": {
"minimum": 0,
"type": "integer",
"description": "Pipeline ID of the bus.\\n Unsigned Integer 32-bit.",
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01"