バージョン
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.
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. |
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 *)
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. |
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\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 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 / ...
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
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. In addition to the listed properties, you can also set wobject properties and references using ; for instance, set the volume by adding the 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 (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. |
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\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 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 / ...
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
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.
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." }, "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\\\\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 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 (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." }, "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\\\\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 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 }
{ "type": "object", "required": [], "properties": {}, "additionalProperties": false }
{ "type": "object", "properties": {}, "additionalProperties": false }
Document version : 1