Scripted object creation and audio file import. The contents of this command very closely mirror that of a tab-delimited import file. See ak.wwise.core.audio.importTabDelimited.
(Required *)
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| importOperation | string | Determines how import object creation is performed. For each object created:
|
| default | object | Default values for each item in "imports". |
| imports * | array | Array of import commands. |
type : string
description : Determines how import object creation is performed. For each object created:
type : object
description : Default values for each item in "imports".
| Name | Type | Description |
|---|---|---|
| importLanguage | string | Import language for audio file import (see documentation for possible values). |
| importLocation | Object ID (GUID) or path used as root relative object paths. | |
| audioFile | string | Path to media file to import. |
| 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\orignalsPath. |
| objectPath | string | The path and name of the object(s) to be created. The path uses backslashes and can either be absolute or relative. |
| objectType | string | Specifies the type of the object to create when importing an audio file. |
| 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 Tab Delimited Import for more information. |
| event | string | Defines the path and name of an Event to be created for the imported object. Refer Tab Delimited Import for more information. |
| dialogueEvent | string | Defines the path and name of a Dialogue Event to be created for the imported object. Refer Tab Delimited Import for more information. |
argsSchema / default / ...
description : Specify the value of the property. Refer to Wwise Objects Reference for the properties available.
Possibilities, one of the following :
1) type : string
2) type : number
3) type : boolean
type : array
description : Array of import commands.
argsSchema / imports / ...
type : object
description : Import command. The members of this object are combined with those of "default", with this object's members having precedence.
| Name | Type | Description |
|---|---|---|
| importLanguage | string | Import language for audio file import (see documentation for possible values). |
| importLocation | Object ID (GUID) or path used as root relative object paths. | |
| audioFile | string | Path to media file to import. |
| 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\orignalsPath. |
| objectPath * | string | The path and name of the object(s) to be created. The path uses backslashes and can either be absolute or relative. |
| objectType | string | Specifies the type of the object to create when importing an audio file. |
| 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 Tab Delimited Import for more information. |
| event | string | Defines the path and name of an Event to be created for the imported object. Refer Tab Delimited Import for more information. |
| dialogueEvent | string | Defines the path and name of a Dialogue Event to be created for the imported object. Refer Tab Delimited Import for more information. |
argsSchema / imports / items / ...
description : Specify the value of the property. Refer to Wwise Objects Reference for the properties available.
Possibilities, one of the following :
1) type : string
2) type : number
3) type : boolean
Creates a new SFX under "objectPath", setting its volume attribute to 1.
{
"importOperation": "createNew",
"default": {},
"imports": [
{
"importLanguage": "SFX",
"@Volume": "1",
"objectPath": "\\Actor-Mixer Hierarchy\\Script Import\\<Actor-Mixer>Test 0\\<Sequence Container>Container 0\\<Sound SFX>My SFX 0"
}
]
}
{}
Imports files specified by "audioFile" into "objectPath"
{
"importOperation": "useExisting",
"default": {
"importLanguage": "SFX"
},
"imports": [
{
"audioFile": "C:\\audio1.wav",
"objectPath": "\\Actor-Mixer Hierarchy\\Script Import\\<Sequence Container>Test 0\\<Sound SFX>My SFX 0"
},
{
"audioFile": "C:\\audio1.wav",
"objectPath": "\\Actor-Mixer Hierarchy\\Script Import\\<Sequence Container>Test 0\\<Sound SFX>Dummy SFX 1"
}
]
}
{}
{
"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 (see documentation for possible values)."
},
"importLocation": {
"description": "Object ID (GUID) or path used as root relative object paths.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"audioFile": {
"type": "string",
"description": "Path to media file to import."
},
"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\\\\orignalsPath."
},
"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."
},
"objectType": {
"type": "string",
"description": "Specifies the type of the object to create when importing an audio file."
},
"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 Tab Delimited Import for more information."
},
"event": {
"type": "string",
"description": "Defines the path and name of an Event to be created for the imported object. Refer Tab Delimited Import for more information."
},
"dialogueEvent": {
"type": "string",
"description": "Defines the path and name of a Dialogue Event to be created for the imported object. Refer Tab Delimited Import for more information."
}
},
"patternProperties": {
"^@[_a-zA-Z][_a-zA-Z0-9]*$": {
"description": "Specify the value of the property.",
"anyOf": [
{
"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.",
"properties": {
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (see documentation for possible values)."
},
"importLocation": {
"description": "Object ID (GUID) or path used as root relative object paths.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"audioFile": {
"type": "string",
"description": "Path to media file to import."
},
"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\\\\orignalsPath."
},
"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."
},
"objectType": {
"type": "string",
"description": "Specifies the type of the object to create when importing an audio file."
},
"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 Tab Delimited Import for more information."
},
"event": {
"type": "string",
"description": "Defines the path and name of an Event to be created for the imported object. Refer Tab Delimited Import for more information."
},
"dialogueEvent": {
"type": "string",
"description": "Defines the path and name of a Dialogue Event to be created for the imported object. Refer Tab Delimited Import for more information."
}
},
"patternProperties": {
"^@[_a-zA-Z][_a-zA-Z0-9]*$": {
"description": "Specify the value of the property.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"objectPath"
]
}
}
},
"required": [
"imports"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise