Version
Wwise SDK 2018.1.11
|
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.
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 (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 / ...
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 @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 / ...
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.
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. |
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 / ...
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]+$
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.
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.
Name | Type | Description |
---|---|---|
objects | array | Array of objects. |
type : array
description : Array of objects.
resultSchema / objects / ...
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 / ...
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 / ...
type : string
description : The name of the object.
resultSchema / objects / items / ...
type : string
description : The notes of the object.
resultSchema / objects / items / ...
type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.
resultSchema / objects / items / ...
type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
resultSchema / objects / items / ...
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 / ...
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 / ...
type : boolean
description : True if the object can be played in Transport.
resultSchema / objects / items / ...
type : integer
description : The short ID of the object.
resultSchema / objects / items / ...
description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295
resultSchema / objects / items / ...
type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'
resultSchema / objects / items / ...
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 / ...
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 / ...
type : number
description : The number of children for the object.
resultSchema / objects / items / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
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 / ...
type : boolean
description : True if the work unit is the default.
resultSchema / objects / items / ...
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 / ...
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 / ...
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 / ...
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. |
Creates a new SFX under "objectPath", setting its volume attribute to 1.
Imports files specified by "audioFile" into "objectPath"
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