Version

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

Schema

{
"type": "object",
"properties": {
"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."
},
"importLanguage": {
"type": "string",
"description": "Imports language for audio file import (taken from the project's defined languages, found in the WPROJ file LanguageList)."
},
"importOperation": {
"type": "string",
"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, the existing object is destroyed.",
"enum": [
"createNew",
"useExisting",
"replaceExisting"
]
},
"importFile": {
"type": "string",
"description": "Location of tab-delimited import file. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"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": [
"importLanguage",
"importOperation",
"importFile"
],
"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