Create Wwise objects and import audio files. This function is using the same importation processor available through the Tab Delimited import in the Audio File Importer. See ak.wwise.core.audio.importTabDelimited. The function returns an array of all objects created, replaced or re-used. Use the options to specify how the objects are returned.
Supported by
Graphical User Interface, Command-Line Interface.
Arguments
| Name |
Type |
Description |
| 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"
|
| default |
object |
Default values for each item in "imports". |
|
imports * |
array |
Array of import commands. |
| 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
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"
default
type : object
description : Default values for each item in "imports".
| Name |
Type |
Description |
| importLanguage |
string |
Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList). |
| importLocation |
 |
Object ID (GUID), name, or path used as root relative object paths. |
| audioFile |
string |
Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| audioFileBase64 |
string |
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...'. |
| originalsSubFolder |
string |
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 will be imported to the folder Originals\SFX\originalsPath. |
| objectPath |
string |
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: \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random container>="">MyContainer\\<Sound>MySound. Refer to \\ref wobjects_index for the available types. |
| objectType |
string |
Specifies the type of the object to create when importing an audio file. This type can also be specified directly in the objectPath. Refer to Wwise Objects Reference for the available types. |
| notes |
string |
The "Notes" field of the created object. |
| audioSourceNotes |
string |
The "Notes" field of the created audio source object. |
| switchAssignation |
string |
Defines a Switch Group or State Group that will be associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child will be assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information. |
| event |
string |
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 |
string |
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. |
argsSchema / default / ...
patternProperties
^@[:_a-zA-Z0-9]+$
description : Specify the value of the property. Refer to Wwise Objects Reference for the properties available.
Possibilities, one of the following :
1) type : null
2) type : string
3) type : number
4) type : boolean
imports
type : array
description : Array of import commands.
argsSchema / imports / ...
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 instance, 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 does not ensure that a reference is set in the required order.
| Name |
Type |
Description |
| importLanguage |
string |
Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList). |
| importLocation |
 |
Object ID (GUID), name, or path used as root relative object paths. |
| audioFile |
string |
Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| audioFileBase64 |
string |
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...'. |
| originalsSubFolder |
string |
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 will be imported to the folder Originals\SFX\originalsPath. |
| objectPath * |
string |
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: \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random container>="">MyContainer\\<Sound>MySound. Refer to \\ref wobjects_index for the available types. |
| objectType |
string |
Specifies the type of the object to create when importing an audio file. This type can also be specified directly in the objectPath. Refer to Wwise Objects Reference for the available types. |
| notes |
string |
The "Notes" field of the created object. |
| audioSourceNotes |
string |
The "Notes" field of the created audio source object. |
| switchAssignation |
string |
Defines a Switch Group or State Group that will be associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child will be assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information. |
| event |
string |
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 |
string |
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. |
(Required *)
argsSchema / imports / items / ...
patternProperties
^@[:_a-zA-Z0-9]+$
description : Specify the value of the property. Refer to Wwise Objects Reference for the properties available.
Possibilities, one of the following :
1) type : null
2) type : string
3) type : number
4) type : boolean
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.
Options
| Name |
Type |
Description |
| return |
array |
Specifies what is being returned for every object. Refer to Wwise Objects Reference for more information on the properties and references available. |
| platform |
 |
The ID (GUID) or name of the platform. |
| language |
 |
The ID (GUID) or name of the language. |
Options Details
return
description : Specifies what is being returned for every object. Refer to Wwise Objects Reference for more information on the properties and references available.
type : array
optionsSchema / return / ...
items
Possibilities, one of the following :
1) type : string
description : Specifies one or many of the built-in accessors for Wwise objects.
Possible values : "id", "name", "notes", "type", "shortId", "classId", "category", "filePath", "workunit", "parent", "owner", "path", "isPlayable", "childrenCount", "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"
2) type : string
description : Specifies one or many property names for Wwise objects. 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 Wwise Objects Reference .
pattern : ^@@?[:_a-zA-Z0-9]+$
platform
Possibilities, one of the following :
1) type : string
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}\}$
description : The ID (GUID) or name of the platform.
language
Possibilities, one of the following :
1) type : string
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}\}$
description : The ID (GUID) or name of the language.
Result
| Name |
Type |
Description |
| objects |
array |
Array of objects. |
Result Details
objects
type : array
description : Array of objects.
resultSchema / objects / ...
items
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 instance, 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 does not ensure that a reference is set in the required order.
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
| name |
string |
The name of the object. |
| notes |
string |
The notes of the object. |
| type |
string |
The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| path |
string |
The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1' |
| parent |
object |
The parent of the object in the hierarchy. |
| owner |
object |
The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc. |
| isPlayable |
boolean |
True if the object can be played in Transport. |
| shortId |
integer |
The short ID of the object. |
| classId |
integer |
The class ID of the object. |
| category |
string |
The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| filePath |
string |
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 Using WAAPI on Mac . |
| workunit |
object |
The parent workunit containing the object. The 'id' and the 'name' will be returned. |
| childrenCount |
number |
The number of children for the object. |
| music:transitionRoot |
object |
The music transition root containing all other music transitions recursively. |
| music:playlistRoot |
object |
The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. |
| sound:originalWavFilePath |
string |
Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| sound:convertedWemFilePath |
string |
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 Using WAAPI on Mac . |
| soundbank:bnkFilePath |
string |
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 Using WAAPI on Mac . |
| audioSource:playbackDuration |
object |
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. |
| audioSource:maxDurationSource |
object |
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. |
| audioSource:trimValues |
object |
Range of time for which the audio source is trimmed. |
| audioSource:maxRadiusAttenuation |
object |
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. |
| audioSource:language |
object |
Language associated to the audio source. This only applies to Audio Source objects directly. |
| workunit:isDefault |
boolean |
True if the work unit is the default. |
| workunit:type |
string |
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".
Possible values : "folder", "rootFile", "nestedFile"
|
| workunit:isDirty |
boolean |
True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved. |
| switchContainerChild:context |
object |
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). |
resultSchema / objects / items / ...
id
description : The ID (GUID) of the object.
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}\}$
resultSchema / objects / items / ...
name
type : string
description : The name of the object.
resultSchema / objects / items / ...
notes
type : string
description : The notes of the object.
resultSchema / objects / items / ...
type
type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.
resultSchema / objects / items / ...
path
type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
resultSchema / objects / items / ...
parent
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
| name |
string |
The name of the object. |
description : The parent of the object in the hierarchy.
resultSchema / objects / items / ...
owner
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
| name |
string |
The name of the object. |
description : The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
resultSchema / objects / items / ...
isPlayable
type : boolean
description : True if the object can be played in Transport.
resultSchema / objects / items / ...
shortId
type : integer
description : The short ID of the object.
resultSchema / objects / items / ...
classId
description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295
resultSchema / objects / items / ...
category
type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'
resultSchema / objects / items / ...
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 Using WAAPI on Mac .
resultSchema / objects / items / ...
workunit
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
| name |
string |
The name of the object. |
description : The parent workunit containing the object. The 'id' and the 'name' will be returned.
resultSchema / objects / items / ...
childrenCount
type : number
description : The number of children for the object.
resultSchema / objects / items / ...
music:transitionRoot
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
description : The music transition root containing all other music transitions recursively.
resultSchema / objects / items / ...
music:playlistRoot
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
description : The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
resultSchema / objects / items / ...
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 Using WAAPI on Mac .
resultSchema / objects / items / ...
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 Using WAAPI on Mac .
resultSchema / objects / items / ...
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 Using WAAPI on Mac .
resultSchema / objects / items / ...
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.
| Name |
Type |
Description |
| playbackDurationMin |
number |
The minimum possible time playback can take. |
| playbackDurationMax |
number |
The maximum possible time playback can take. |
| playbackDurationType |
string |
The type of duration. |
resultSchema / objects / items / ...
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.
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the audio source object with longest duration. |
| trimmedDuration |
number |
The duration in seconds of the longest trimmed source. |
resultSchema / objects / items / ...
audioSource:trimValues
type : object
description : Range of time for which the audio source is trimmed.
| Name |
Type |
Description |
| trimBegin |
number |
The time value in seconds of the start trim. |
| trimEnd |
number |
The time value in seconds of the end trim. |
resultSchema / objects / items / ...
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.
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the attenuation object with the largest radius. |
| radius |
number |
The radius of the attenuation object. |
resultSchema / objects / items / ...
audioSource:language
type : object
description : Language associated to the audio source. This only applies to Audio Source objects directly.
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the Language object to which the Audio Source object is associated. |
| name |
string |
The name of the Language object to which the Audio Source object is associated. |
resultSchema / objects / items / ...
workunit:isDefault
type : boolean
description : True if the work unit is the default.
resultSchema / objects / items / ...
workunit:type
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".
Possible values : "folder", "rootFile", "nestedFile"
resultSchema / objects / items / ...
workunit:isDirty
type : boolean
description : True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
resultSchema / objects / items / ...
switchContainerChild:context
type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the 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).
resultSchema / objects / items / ...
patternProperties
^@@?[:_a-zA-Z0-9]+$
description : Specifies the property or reference value. 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 Wwise Objects Reference for more information on the properties and references for all types available.
Possibilities, one of the following :
1) type : string
2) type : number
3) type : boolean
4) type : object
| Name |
Type |
Description |
| id |
string |
The ID (GUID) of the object. |
| name |
string |
The name of the object. |
Examples :
Importing a new SFX and setting a value to a property
Creates a new SFX under "objectPath", setting its volume attribute to 1.
Arguments:
{
"importOperation": "createNew",
"default": {},
"imports": [
{
"importLanguage": "SFX",
"@Volume": "1",
"objectPath": "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Actor-Mixer>Test 0\\<Sequence Container>Container 0\\<Sound SFX>Sound 0"
}
]
}
Result:
{
"objects": [
{
"name": "Test 0",
"id": "{47EF0874-4C86-4DB6-A63B-4411A1EA766E}"
},
{
"name": "Container 0",
"id": "{E9AD319F-BCC3-43C0-9645-851B758A86FD}"
},
{
"name": "Sound 0",
"id": "{692C77EB-7542-4AE9-A56A-ADB9D4CE0008}"
}
]
}
Importing audio files to SFXs WwiseObjects
Imports files specified by "audioFile" into "objectPath"
Arguments:
{
"importOperation": "useExisting",
"default": {
"importLanguage": "SFX"
},
"imports": [
{
"audioFile": "C:\\audio0.wav",
"objectPath": "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sequence Container>Test 0\\<Sound SFX>My SFX 0"
},
{
"audioFile": "C:\\audio1.wav",
"objectPath": "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sequence Container>Test 0\\<Sound SFX>My SFX 1"
}
]
}
Options:
{
"return": [
"id",
"name",
"path"
]
}
Result:
{
"objects": [
{
"name": "Test 0",
"id": "{E81CAE71-7361-4F4B-BE36-817B8ADF26FD}",
"path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\Test 0"
},
{
"name": "My SFX 0",
"id": "{F5F8A5B9-B5F4-4E82-AB9E-AA3BD997F98C}",
"path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\Test 0\\My SFX 0"
},
{
"name": "My SFX 1",
"id": "{0366B1D9-740A-4980-B411-F1012BF73E69}",
"path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\Test 0\\My SFX 1"
}
]
}
Detailed JSON Schema
Arguments :
{
"type": "object",
"properties": {
"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"
]
},
"default": {
"type": "object",
"description": "Default values for each item in \"imports\".",
"properties": {
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList)."
},
"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": "^\\\\"
}
]
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise."
},
"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 will be 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: \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound."
},
"objectType": {
"type": "string",
"description": "Specifies the type of the object to create when importing an audio file. This type can also be specified directly in the objectPath."
},
"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 will be associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child will be 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": "Specify the value of the property.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"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 instance, 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 does not ensure that a reference is set in the required order.",
"properties": {
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList)."
},
"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": "^\\\\"
}
]
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise."
},
"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 will be 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: \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound."
},
"objectType": {
"type": "string",
"description": "Specifies the type of the object to create when importing an audio file. This type can also be specified directly in the objectPath."
},
"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 will be associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child will be 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": "Specify the value of the property.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"objectPath"
]
}
},
"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": [
"imports"
],
"additionalProperties": false
}
Options :
{
"description": "Specifies the return options for every object returned.",
"type": "object",
"properties": {
"return": {
"description": "Specifies what is being returned for every object.",
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"description": "Specifies one or many of the built-in accessors for Wwise objects.",
"enum": [
"id",
"name",
"notes",
"type",
"shortId",
"classId",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"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 property names for Wwise objects. 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.",
"pattern": "^@@?[:_a-zA-Z0-9]+$"
}
]
}
},
"platform": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
}
],
"description": "The ID (GUID) or name of the platform."
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
}
],
"description": "The ID (GUID) or name of the language."
}
},
"additionalProperties": false
}
Response :
{
"type": "object",
"properties": {
"objects": {
"type": "array",
"description": "Array of objects.",
"items": {
"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 instance, 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 does not ensure that a reference is set in the required order.",
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"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."
},
"path": {
"type": "string",
"description": "The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'"
},
"parent": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The parent of the object in the hierarchy."
},
"owner": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc."
},
"isPlayable": {
"type": "boolean",
"description": "True if the object can be played in Transport."
},
"shortId": {
"type": "integer",
"description": "The short ID of the object."
},
"classId": {
"description": "The class ID of the object.",
"type": "integer",
"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."
},
"workunit": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The parent workunit containing the object. The 'id' and the 'name' will be returned."
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object."
},
"music:transitionRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music transition root containing all other music transitions recursively."
},
"music:playlistRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only."
},
"sound:originalWavFilePath": {
"type": "string",
"description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects."
},
"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."
},
"soundbank:bnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects."
},
"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."
}
}
},
"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.",
"properties": {
"id": {
"description": "The ID (GUID) of the audio source object with longest duration.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"trimmedDuration": {
"type": "number",
"description": "The duration in seconds of the longest trimmed source."
}
}
},
"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": {
"id": {
"description": "The ID (GUID) of the attenuation object with the largest radius.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
}
}
},
"audioSource:language": {
"type": "object",
"description": "Language associated to the audio source. This only applies to Audio Source objects directly.",
"properties": {
"id": {
"description": "The ID (GUID) of the Language object to which the Audio Source object is associated.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the Language object to which the Audio Source object is associated."
}
}
},
"workunit:isDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"workunit:type": {
"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\".",
"enum": [
"folder",
"rootFile",
"nestedFile"
]
},
"workunit:isDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved."
},
"switchContainerChild:context": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"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)."
}
},
"patternProperties": {
"^@@?[:_a-zA-Z0-9]+$": {
"description": "Specifies the property or reference value. 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.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
}
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
Document version : 1