Version

menu_open
Wwise SDK 2018.1.11
ak.wwise.core.audio.importTabDelimited


Scripted object creation and audio file import from a tab-delimited file.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
importLocation   Object ID (GUID), name, or path used as root relative object paths.
importLanguage * string Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList).
importOperation * string Determines how import object creation is performed. For each object created:
  • createNew: will create a new object; the object will be given the desired name if possible, otherwise a new unique name will be used.
  • useExisting: will use the object if it exists, updating the specified properties; otherwise it will create a new object. This is the default value.
  • replaceExisting: will create a new object; if an existing object has the same name then the existing object is destroyed.
    Possible values : "createNew", "useExisting", "replaceExisting"
importFile * string Location of tab-delimited import file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
autoAddToSourceControl boolean Determines if Wwise will automatically perform an Add or Checkout operation on the imported files with the source control. Defaults to false.

(Required *)

Arguments Details


importLocation

description : Object ID (GUID), name, or path used as root relative object paths.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
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.

2) 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}\}$

3) type : string
pattern : ^\

importLanguage

type : string
description : Import language for audio file import (from among 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:

  • createNew: will create a new object; the object will be given the desired name if possible, otherwise a new unique name will be used.
  • useExisting: will use the object if it exists, updating the specified properties; otherwise it will create a new object. This is the default value.
  • replaceExisting: will create a new object; if an existing object has the same name then the existing object is destroyed.
    Possible values : "createNew", "useExisting", "replaceExisting"

importFile

type : string
description : Location of tab-delimited import file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

autoAddToSourceControl

type : boolean
description : Determines if Wwise will automatically perform an Add or Checkout operation on the imported files with the source control. Defaults to false.


Examples :

Importing an audio file

Imports an audio file from a tab-delimited file

Arguments:

{
"importLocation": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"importLanguage": "SFX",
"importOperation": "createNew",
"importFile": "C:\\MyWaves\\MyFolder\\myImportFile.txt"
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"importLocation": {
"description": "Object ID (GUID), name, or path used as root relative object paths.",
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$",
"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."
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (from among 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:
- createNew: will create a new object; the object will be given the desired name if possible, otherwise a new unique name will be used.
- useExisting: will use the object if it exists, updating the specified properties; otherwise it will create a new object. This is the default value.
- replaceExisting: will create a new object; if an existing object has the same name then the existing object is destroyed.",
"enum": [
"createNew",
"useExisting",
"replaceExisting"
]
},
"importFile": {
"type": "string",
"description": "Location of tab-delimited import file."
},
"autoAddToSourceControl": {
"type": "boolean",
"description": "Determines if Wwise will automatically perform an Add or Checkout operation on the imported files with the source control. Defaults to false."
}
},
"required": [
"importLanguage",
"importOperation",
"importFile"
],
"additionalProperties": false
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {},
"additionalProperties": false
}

Document version : 1


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