Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.soundbank.generated Publish Schema

Schema

{
"type": "object",
"localDefinitions": {
"switchContainer": {
"type": "object",
"description": "Association of switch container value to its used resources.",
"properties": {
"SwitchValue": {
"type": "object",
"description": "Group id and value used for switch container.",
"properties": {
"GroupType": {
"type": "string",
"enum": [
"Switch",
"State"
],
"description": "Group type."
},
"GroupId": {
"type": "string",
"description": "Switch/State group short Id."
},
"Id": {
"type": "string",
"description": "Switch/State short Id."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the switch container value used.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"Default": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether the Switch/State value is the switch container's default. If not specified then the value is false."
}
},
"required": [
"GroupType",
"GroupId",
"Id"
],
"additionalProperties": false
},
"MediaRefs": {
"type": "array",
"description": "List of all media files used by this event.",
"items": {
"type": "object",
"description": "Referenced media file entry\\n Media file descriptor reference",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ExternalSourceRefs": {
"type": "array",
"description": "List of all external sources used by this event.",
"items": {
"type": "object",
"description": "Referenced external source entry\\n External Source descriptor reference.",
"properties": {
"Cookie": {
"type": "string",
"description": "Cookie assigned to external source."
}
},
"required": [
"Cookie"
],
"additionalProperties": false
}
},
"PluginRefs": {
"type": "object",
"description": "List of all plug-ins used by this event.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Children": {
"type": "array",
"description": "Children of this switch container value.",
"items": {
"type": "object",
"description": "Child entry of the switch container\\n Association of switch container value to its used resources.",
"properties": {
"SwitchValue": {
"type": "object",
"description": "Group id and value used for switch container.",
"properties": {
"GroupType": {
"type": "string",
"enum": [
"Switch",
"State"
],
"description": "Group type."
},
"GroupId": {
"type": "string",
"description": "Switch/State group short Id."
},
"Id": {
"type": "string",
"description": "Switch/State short Id."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the switch container value used.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"Default": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether the Switch/State value is the switch container's default. If not specified then the value is false."
}
},
"required": [
"GroupType",
"GroupId",
"Id"
],
"additionalProperties": false
},
"MediaRefs": {
"type": "array",
"description": "List of all media files used by this event.",
"items": {
"type": "object",
"description": "Referenced media file entry\\n Media file descriptor reference",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ExternalSourceRefs": {
"type": "array",
"description": "List of all external sources used by this event.",
"items": {
"type": "object",
"description": "Referenced external source entry\\n External Source descriptor reference.",
"properties": {
"Cookie": {
"type": "string",
"description": "Cookie assigned to external source."
}
},
"required": [
"Cookie"
],
"additionalProperties": false
}
},
"PluginRefs": {
"type": "object",
"description": "List of all plug-ins used by this event.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Children": {
"type": "array",
"description": "Children of this switch container value.",
"items": {
"$ref": "#/localDefinitions/switchContainer",
"description": "Child entry of the switch container"
}
}
},
"required": [
"SwitchValue"
],
"additionalProperties": false
}
}
},
"required": [
"SwitchValue"
],
"additionalProperties": false
}
},
"properties": {
"soundbank": {
"type": "object",
"description": "The generated SoundBank. Use the return options to obtain specific details.\\n A Wwise object. Use the return options to specify which property is required.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
},
"notes": {
"type": "string",
"description": "The notes of the object."
},
"type": {
"type": "string",
"description": "The type of the object. Refer to \\ref wobjects_index for more information on the types available."
},
"pluginName": {
"type": "string",
"description": "The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in."
},
"path": {
"type": "string",
"description": "The path of the object from the project root. Ex: '\\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\Sound1'"
},
"parent": {
"type": "object",
"description": "The parent of the object in the hierarchy.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
}
},
"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.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
}
},
"isPlayable": {
"type": "boolean",
"description": "True if the object can be played in Transport."
},
"shortId": {
"type": "integer",
"description": "The Short ID of the object."
},
"classId": {
"type": "integer",
"description": "The class ID of the object.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"category": {
"type": "string",
"description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
},
"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": {
"type": "object",
"description": "The parent Work Unit containing the object. The 'id' and the 'name' is returned.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
}
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object. Note, this is deprecated. The same result can be obtained with children.count()."
},
"totalSize": {
"type": "integer",
"description": "The amount of space (in bytes) this object and all of its children take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate."
},
"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."
},
"objectSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object takes up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
},
"structureSize": {
"type": "integer",
"description": "The amount of space (in bytes) the meta-data of the object and all of its children take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate."
},
"musicTransitionRoot": {
"type": "object",
"description": "(DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"musicPlaylistRoot": {
"type": "object",
"description": "(DEPRECATED) The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. Note, this is deprecated. The PlaylistRoot reference should be used instead.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"originalWavFilePath": {
"type": "string",
"description": "(DEPRECATED) 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 ."
},
"originalFilePath": {
"type": "string",
"description": "Absolute path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"originalRelativeFilePath": {
"type": "string",
"description": "Relative (from project's Originals Folder) path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"activeSource": {
"type": "object",
"description": "The active source of the sound object.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
}
},
"convertedWemFilePath": {
"type": "string",
"description": "(DEPRECATED) Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"convertedFilePath": {
"type": "string",
"description": "Absolute path to the converted file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"soundbankBnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. To use WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"playbackDuration": {
"type": "object",
"description": "The duration root that contains the min and max durations and duration type. Note, this is deprecated. The duration should be used instead. 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."
}
}
},
"duration": {
"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": {
"min": {
"type": "number",
"description": "The minimum possible time playback can take."
},
"max": {
"type": "number",
"description": "The maximum possible time playback can take."
},
"type": {
"type": "string",
"description": "The type of duration."
}
}
},
"maxDurationSource": {
"type": "object",
"description": "Audio source with the longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the audio source object with the 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."
}
}
},
"audioSourceTrimValues": {
"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."
}
}
},
"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": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the attenuation object with the largest radius.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
}
}
},
"audioSourceLanguage": {
"type": "object",
"description": "Language associated to the audio source. This only applies to Audio Source objects directly.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
}
},
"workunitIsDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"workunitType": {
"type": "string",
"description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders have the workunitType \"folder\".",
"enum": [
"folder",
"rootFile",
"nestedFile"
]
},
"workunitIsDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved."
},
"switchContainerChildContext": {
"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: the properties of the '1st only' checkbox).",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
}
},
"isExplicitMute": {
"type": "boolean",
"description": "Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects."
},
"isExplicitSolo": {
"type": "boolean",
"description": "Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one."
},
"isImplicitMute": {
"type": "boolean",
"description": "Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects."
},
"isImplicitSolo": {
"type": "boolean",
"description": "Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one."
},
"isIncluded": {
"type": "boolean",
"description": "Whether or not the object is Included. Specify the platform in the options. This takes into consideration the Inclusion status of the object's ancestors."
},
"points": {
"type": "array",
"description": "This only applies to Curve objects.\\n An array of points defining a curve.",
"items": {
"type": "object",
"description": "A point in the curve.",
"properties": {
"x": {
"type": "number",
"description": "X coordinate of curve point."
},
"y": {
"type": "number",
"description": "Y coordinate of curve point."
},
"shape": {
"type": "string",
"description": "Shape of the curve segment between this point and the next.",
"enum": [
"Constant",
"Linear",
"Log3",
"Log2",
"Log1",
"InvertedSCurve",
"SCurve",
"Exp1",
"Exp2",
"Exp3"
]
}
},
"required": [
"x",
"y",
"shape"
],
"additionalProperties": false
}
},
"stateProperties": {
"type": "array",
"description": "An array of state properties to set.",
"items": {
"description": "The name of the property to set.",
"type": "string"
}
},
"stateGroups": {
"type": "array",
"description": "The State Group objects associated with this object.",
"items": {
"type": "object",
"description": "A State Group object.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the State Group object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the State Group object."
}
}
}
}
},
"patternProperties": {
"^((@?@?[a-zA-Z0-9:_\\‍(\\‍),]+)|[a-zA-Z\\‍(\\‍),]+\\‍(.+\\‍))(\\.@?@?[a-zA-Z0-9:_\\‍(\\‍),]+|[a-zA-Z\\‍(\\‍),]+\\‍(.+\\‍))*$": {
"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 for the source of override. Refer to \\ref wobjects_index for more information on the properties and references for all types available.",
"anyOf": [
{
"type": "string",
"description": "A string value."
},
{
"type": "array",
"description": "An array of string values.",
"items": {
"type": "string",
"description": "A string value."
}
},
{
"type": "number",
"description": "A numeric value."
},
{
"type": "array",
"description": "An array of numeric values.",
"items": {
"type": "number",
"description": "A numeric value."
}
},
{
"type": "boolean",
"description": "A boolean value."
},
{
"type": "array",
"description": "An array of boolean values.",
"items": {
"type": "boolean",
"description": "A boolean value."
}
},
{
"type": "object",
"description": "An object reference value.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
},
"additionalProperties": true
},
{
"type": "array",
"description": "An object list reference value.",
"items": {
"type": "object",
"description": "An object reference value.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"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."
}
},
"additionalProperties": true
}
}
]
}
},
"additionalProperties": true
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the resulting SoundBank.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"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."
},
"Type": {
"type": "string",
"description": "SoundBank type. If the SoundBank is defined by the user, then the type is 'User'. Otherwise, the bank was auto defined by Wwise.",
"enum": [
"User",
"Event",
"Bus"
]
},
"Hash": {
"type": "string",
"description": "Hash value (128-bit) written to the associated SoundBank .bnk file. Used during SoundBank generation to check existing .bnk files for changes."
},
"Align": {
"type": "string",
"description": "Required alignment for media file. If not specified then the alignment is 16 bytes."
},
"DeviceMemory": {
"type": "string",
"description": "Does the media requires device memory or not.",
"enum": [
"true",
"false"
]
},
"Media": {
"type": "array",
"description": "All media files referenced by this SoundBank with their information.",
"items": {
"type": "object",
"description": "Media file descriptor",
"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."
},
"CachePath": {
"type": "string",
"description": "Path of the converted media relative to the cache folder."
},
"Path": {
"type": "string",
"description": "Path of the copied media file (if copied) relative to the output folder."
},
"PrefetchSize": {
"type": "string",
"description": "Prefetch size in bytes."
},
"Align": {
"type": "string",
"description": "Required alignment for media file in bytes. If not specified then the alignment is 16 bytes."
},
"DeviceMemory": {
"type": "string",
"description": "Does the media requires device memory or not. If not specified then the value is false.",
"enum": [
"true",
"false"
]
},
"Streaming": {
"type": "string",
"description": "Is the file streamed. If not specified then the value is false.",
"enum": [
"true",
"false"
]
},
"Location": {
"type": "string",
"description": "Where is file located. In the case of a streamed file with prefetch, this will indicate where to find the prefetched portion.",
"enum": [
"Memory",
"Loose",
"OtherBank"
]
},
"UsingReferenceLanguage": {
"type": "string",
"description": "Is the media using the reference language. If not specified then the value is false.",
"enum": [
"true",
"false"
]
}
},
"required": [
"Id",
"ShortName",
"CachePath",
"Streaming",
"Location"
],
"additionalProperties": false
}
},
"ExternalSources": {
"type": "array",
"description": "All external sources referenced by this SoundBank with their information.",
"items": {
"#ref": "#/definitions/externalSourceDescriptor",
"description": "External source descriptor."
}
},
"Plugins": {
"#ref": "#/definitions/pluginDescriptorGroup",
"description": "Plug-in descriptors."
},
"Events": {
"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."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the event.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"MaxAttenuation": {
"type": "string",
"description": "The max distance for the 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."
},
"MediaRefs": {
"type": "array",
"description": "List of all media files used by this event.",
"items": {
"type": "object",
"description": "Referenced media file entry\\n Media file descriptor reference",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ExternalSourceRefs": {
"type": "array",
"description": "List of all external sources used by this event.",
"items": {
"type": "object",
"description": "Referenced external source entry\\n External Source descriptor reference.",
"properties": {
"Cookie": {
"type": "string",
"description": "Cookie assigned to external source."
}
},
"required": [
"Cookie"
],
"additionalProperties": false
}
},
"PluginRefs": {
"type": "object",
"description": "List of all plug-ins used by this event.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"AuxBusRefs": {
"type": "array",
"description": "List of all Aux Busses referenced by this event.",
"items": {
"type": "object",
"description": "Reference to Aux Bus.\\n Aux Bus reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of Aux Bus."
},
"Name": {
"type": "string",
"description": "Name of the Aux Bus."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Aux Bus.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"ActionSetState": {
"type": "array",
"description": "List of set State actions in Event.",
"items": {
"type": "object",
"description": "Set State Action information.",
"properties": {
"GroupId": {
"type": "string",
"description": "Short ID of the State Group."
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the State.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"GroupId",
"Id",
"Name"
],
"additionalProperties": false
}
},
"ActionSetSwitch": {
"type": "array",
"description": "List of set Switch actions in Event.",
"items": {
"type": "object",
"description": "Set Switch Action information.",
"properties": {
"GroupId": {
"type": "string",
"description": "Short ID of the Switch Group."
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Switch.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"GroupId",
"Id",
"Name"
],
"additionalProperties": false
}
},
"ActionTrigger": {
"type": "array",
"description": "List of Trigger actions in Event.",
"items": {
"type": "object",
"description": "Trigger Action information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Trigger."
},
"Name": {
"type": "string",
"description": "Name of the Trigger."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Trigger.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"ActionSetFX": {
"type": "array",
"description": "List of Set Effect actions in Event.",
"items": {
"type": "object",
"description": "Set Effect Action information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Effect."
},
"Name": {
"type": "string",
"description": "Name of the Effect."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Effect.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"SwitchContainers": {
"type": "array",
"description": "List of association of switch container value to its used media.",
"items": {
"type": "object",
"description": "SwitchContainer entry\\n Association of switch container value to its used resources.",
"properties": {
"SwitchValue": {
"type": "object",
"description": "Group id and value used for switch container.",
"properties": {
"GroupType": {
"type": "string",
"enum": [
"Switch",
"State"
],
"description": "Group type."
},
"GroupId": {
"type": "string",
"description": "Switch/State group short Id."
},
"Id": {
"type": "string",
"description": "Switch/State short Id."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the switch container value used.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"Default": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether the Switch/State value is the switch container's default. If not specified then the value is false."
}
},
"required": [
"GroupType",
"GroupId",
"Id"
],
"additionalProperties": false
},
"MediaRefs": {
"type": "array",
"description": "List of all media files used by this event.",
"items": {
"type": "object",
"description": "Referenced media file entry\\n Media file descriptor reference",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the media."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ExternalSourceRefs": {
"type": "array",
"description": "List of all external sources used by this event.",
"items": {
"type": "object",
"description": "Referenced external source entry\\n External Source descriptor reference.",
"properties": {
"Cookie": {
"type": "string",
"description": "Cookie assigned to external source."
}
},
"required": [
"Cookie"
],
"additionalProperties": false
}
},
"PluginRefs": {
"type": "object",
"description": "List of all plug-ins used by this event.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Children": {
"type": "array",
"description": "Children of this switch container value.",
"items": {
"$ref": "#/localDefinitions/switchContainer",
"description": "Child entry of the switch container"
}
}
},
"required": [
"SwitchValue"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"DialogueEvents": {
"type": "array",
"description": "All the dialogue events included in this SoundBank with their information.",
"items": {
"type": "object",
"description": "Dialogue Event information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the dialogue event."
},
"Name": {
"type": "string",
"description": "Name of the dialogue event."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the dialogue event.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"Arguments": {
"type": "array",
"description": "List of dialogue event's arguments.",
"items": {
"type": "object",
"description": "Argument information",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the dialogue event."
},
"Name": {
"type": "string",
"description": "Name of the dialogue event."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the dialogue event.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"Busses": {
"type": "array",
"description": "List of all AuxBus used in this SoundBank.",
"items": {
"type": "object",
"description": "Bus information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Bus."
},
"Name": {
"type": "string",
"description": "Name of the Bus."
},
"MaxAttenuation": {
"type": "string",
"description": "The max distance for the attenuation of the bus as a floating point value."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Bus.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"PluginRefs": {
"type": "object",
"description": "Array of plug-in references.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"AuxBusRefs": {
"type": "array",
"description": "List of Aux Busses referenced by this event.",
"items": {
"type": "object",
"description": "Reference to Aux Bus.\\n Aux Bus reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of Aux Bus."
},
"Name": {
"type": "string",
"description": "Name of the Aux Bus."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Aux Bus.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"AuxBusses": {
"type": "array",
"description": "List of all AuxBus used in this SoundBank.",
"items": {
"type": "object",
"description": "AuxBus information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the AuxBus."
},
"Name": {
"type": "string",
"description": "Name of the AuxBus."
},
"MaxAttenuation": {
"type": "string",
"description": "The max distance for the attenuation of the aux bus as a floating point value."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the AuxBus.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"PluginRefs": {
"type": "object",
"description": "Array of plug-in references.\\n Plug-in descriptor reference.",
"properties": {
"Custom": {
"type": "array",
"description": "Array of references to custom plug-in instances.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"ShareSets": {
"type": "array",
"description": "Array of references to plug-in sharesets.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
},
"AudioDevices": {
"type": "array",
"description": "Array of references to audio device plug-ins.",
"items": {
"type": "object",
"description": "Plug-in descriptor reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of plug-in instance."
}
},
"required": [
"Id"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"AuxBusRefs": {
"type": "array",
"description": "List of all Aux Busses referenced by this event.",
"items": {
"type": "object",
"description": "Reference to Aux Bus.\\n Aux Bus reference.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of Aux Bus."
},
"Name": {
"type": "string",
"description": "Name of the Aux Bus."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Aux Bus.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"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."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Game Parameter.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"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."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Trigger.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the State Group.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the State.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the SwitchGroup.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"GameParameterRef": {
"type": "object",
"description": "Game Parameter used to control the Switch Group.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Game Parameter."
}
},
"required": [
"Id"
],
"additionalProperties": false
},
"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": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Switch.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
},
"AcousticTextures": {
"type": "array",
"description": "List of all Acoustic Textures used in this SoundBank.",
"items": {
"type": "object",
"description": "Acoustic texture information.",
"properties": {
"Id": {
"type": "string",
"description": "Short ID of the Acoustic Texture."
},
"Name": {
"type": "string",
"description": "Name of the Acoustic Texture."
},
"ObjectPath": {
"type": "string",
"description": "Object path in the project."
},
"GUID": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "GUID of the Acoustic Texture.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"Properties": {
"type": "array",
"description": "List of Acoustic Texture properties.",
"items": {
"type": "object",
"description": "Acoustic Texture property information.",
"properties": {
"Name": {
"type": "string",
"description": "Acoustic Texture property name."
},
"Type": {
"type": "string",
"description": "Acoustic Texture property type."
},
"Value": {
"type": "string",
"description": "Acoustic Texture property value."
}
}
}
}
},
"required": [
"Id",
"Name"
],
"additionalProperties": false
}
}
},
"required": [
"Id",
"ShortName",
"Language"
],
"additionalProperties": false
}
},
"pluginInfo": {
"type": "object",
"description": "PluginInfo file info",
"properties": {
"Platform": {
"type": "string",
"description": "Name of the platform."
},
"BasePlatform": {
"type": "string",
"description": "The base platform the current platform is based off."
},
"PluginLibs": {
"type": "array",
"description": "List of the plugins",
"items": {
"type": "object",
"description": "Plugin information.",
"properties": {
"LibName": {
"type": "string",
"description": "Display Name of the plugin."
},
"LibId": {
"type": "string",
"description": "Short ID of the plugin."
},
"Type": {
"type": "string",
"description": "Type of the plugin."
},
"DLL": {
"type": "string",
"description": "Name of the DLL for the plugin."
},
"StaticLib": {
"type": "string",
"description": "Name of the static lib for the plugin."
}
},
"required": [
"LibName",
"LibId",
"Type"
],
"additionalProperties": false
}
}
},
"required": [
"Platform",
"BasePlatform"
],
"additionalProperties": false
}
},
"required": [
"soundbank",
"platform"
],
"additionalProperties": false
}

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