Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.audio.import Arguments Schema

Schema

{
"type": "object",
"properties": {
"importOperation": {
"type": "string",
"enum": [
"createNew",
"useExisting",
"replaceExisting"
],
"description": "Determines how import object creation is performed. For each object created:\n- createNew: creates a new object; the object is given the desired name if possible, otherwise a new unique name is used.\n- useExisting: uses the object if it exists, updating the specified properties; otherwise it creates a new object. This is the default value.\n- replaceExisting: creates a new object; if an existing object has the same name then the existing object is destroyed."
},
"default": {
"type": "object",
"description": "Default values for each item in \"imports\". Use this object to avoid repeating common properties of every imported element.",
"properties": {
"importLanguage": {
"type": "string",
"description": "Imports the language for the audio file import (taken from the project's defined languages, found in the WPROJ file LanguageList)."
},
"importLocation": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792"
},
{
"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": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"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."
}
],
"description": "Object ID (GUID), name, or path used as root relative object paths."
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"audioFileBase64": {
"type": "string",
"description": "Base64 encoded WAV audio file data to import with its target file path relative to the Originals folder, separated by a vertical bar. E.g. 'MySound.wav|UklGRu...'.",
"pattern": "^(.+\\.wav\\|((?:[A-Za-z0-9\\+\\/]{4})*(?:[A-Za-z0-9\\+\\/]{2}==|[A-Za-z0-9\\+\\/]{3}=))+)$"
},
"originalsSubFolder": {
"type": "string",
"description": "Specifies the 'originals' sub-folder in which to place the imported audio file. This folder is relative to the 'originals' folder in which the file would normally be imported. Example: if importing an SFX, then the audio file is imported to the folder Originals\\\\SFX\\\\originalsPath."
},
"objectPath": {
"type": "string",
"description": "The path and name of the object(s) to be created. The path uses backslashes and can either be absolute or relative. Object types can be specified before the name. For example: \\verbatim \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\<Random Container>MyContainer\\\<Sound>MySound. \\endverbatim Refer to \\ref wobjects_index for the available types."
},
"objectType": {
"type": "string",
"description": "Specifies the type of object to create when importing an audio file. This type can also be specified directly in the objectPath. Refer to \\ref wobjects_index for the available types."
},
"notes": {
"type": "string",
"description": "The \"Notes\" field of the created object."
},
"audioSourceNotes": {
"type": "string",
"description": "The \"Notes\" field of the created audio source object."
},
"switchAssignation": {
"type": "string",
"description": "Defines a Switch Group or State Group that is associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child is assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
},
"event": {
"type": "string",
"description": "Defines the path and name of an Event to be created for the imported object. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
},
"dialogueEvent": {
"type": "string",
"description": "Defines the path and name of a Dialogue Event to be created for the imported object. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Specifies a Wwise object property and its value. Property names are prefixed with @. Refer to \\ref wobjects_index for the properties available. For example: \\@Volume:3\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"additionalProperties": false
},
"imports": {
"type": "array",
"description": "Array of import commands.",
"items": {
"type": "object",
"description": "Import command. The members of this object are combined with those of \"default\", with this object's members having precedence. In addition to the listed properties, you can also set wobject properties and references using \\@Property. For example, you can set the volume by adding the \\@Volume property. References that have constraints from other references, such as a Switch Container's State/Switch, which is constrained to being a child of a State/Switch Group, should not be set because WAAPI cannot ensure that a reference is set in the required order.",
"properties": {
"importLanguage": {
"type": "string",
"description": "Imports the language for the audio file import (taken from the project's defined languages, found in the WPROJ file LanguageList)."
},
"importLocation": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792"
},
{
"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": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"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."
}
],
"description": "Object ID (GUID), name, or path used as root relative object paths."
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"audioFileBase64": {
"type": "string",
"description": "Base64 encoded WAV audio file data to import with its target file path relative to the Originals folder, separated by a vertical bar. E.g. 'MySound.wav|UklGRu...'.",
"pattern": "^(.+\\.wav\\|((?:[A-Za-z0-9\\+\\/]{4})*(?:[A-Za-z0-9\\+\\/]{2}==|[A-Za-z0-9\\+\\/]{3}=))+)$"
},
"originalsSubFolder": {
"type": "string",
"description": "Specifies the 'originals' sub-folder in which to place the imported audio file. This folder is relative to the 'originals' folder in which the file would normally be imported. Example: if importing an SFX, then the audio file is imported to the folder Originals\\\\SFX\\\\originalsPath."
},
"objectPath": {
"type": "string",
"description": "The path and name of the object(s) to be created. The path uses backslashes and can either be absolute or relative. Object types can be specified before the name. For example: \\verbatim \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\<Random Container>MyContainer\\\<Sound>MySound. \\endverbatim Refer to \\ref wobjects_index for the available types."
},
"objectType": {
"type": "string",
"description": "Specifies the type of object to create when importing an audio file. This type can also be specified directly in the objectPath. Refer to \\ref wobjects_index for the available types."
},
"notes": {
"type": "string",
"description": "The \"Notes\" field of the created object."
},
"audioSourceNotes": {
"type": "string",
"description": "The \"Notes\" field of the created audio source object."
},
"switchAssignation": {
"type": "string",
"description": "Defines a Switch Group or State Group that is associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child is assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
},
"event": {
"type": "string",
"description": "Defines the path and name of an Event to be created for the imported object. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
},
"dialogueEvent": {
"type": "string",
"description": "Defines the path and name of a Dialogue Event to be created for the imported object. Refer to Tab Delimited Import in the Wwise Help documentation for more information."
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Specifies the value of the property. Refer to \\ref wobjects_index for the properties available.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"additionalProperties": false,
"required": [
"objectPath"
]
}
},
"autoAddToSourceControl": {
"type": "boolean",
"description": "Determines if Wwise automatically performs a source control Add operation on the imported files. Defaults to true."
},
"autoCheckOutToSourceControl": {
"type": "boolean",
"description": "Determines if Wwise automatically performs a source control Checkout operation (when applicable) on the modified files. Defaults to true."
}
},
"required": [
"imports"
],
"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