Version

menu_open
Wwise SDK 2023.1.4
ak.wwise.core.audio.import

Creates Wwise objects and imports audio files. This function does not return an error when something fails during the import process, please refer to the log for the result of each import command. This function uses the same importation processor available through the Tab Delimited import in the Audio File Importer. The function returns an array of all objects created, replaced or re-used. Use the options to specify how the objects are returned. For more information, refer to Importing Audio Files and Creating Structures.

Arguments

Name Type Description
importOperation string Determines how import object creation is performed. For each object created:
  • createNew: creates a new object; the object is given the desired name if possible, otherwise a new unique name is used.
  • useExisting: uses the object if it exists, updating the specified properties; otherwise it creates a new object. This is the default value.
  • replaceExisting: creates 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". Use this object to avoid repeating common properties of every imported element.
default.importLanguage string Imports the language for the audio file import (taken from the project's defined languages, found in the WPROJ file LanguageList).
default.importLocation any of: Object ID (GUID), name, or path used as root relative object paths.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
default.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 .
default.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...'.
default.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 is imported to the folder Originals\SFX\originalsPath.
default.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 Wwise Objects Reference for the available types.
default.objectType string Specifies the type of 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.
default.notes string The "Notes" field of the created object.
default.audioSourceNotes string The "Notes" field of the created audio source object.
default.switchAssignation string Defines a Switch Group or State Group that is associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child is assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information.
default.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.
default.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.
default.regex(^@[:_a-zA-Z0-9]+$) any of: Specifies a Wwise object property and its value. Property names are prefixed with . Refer to Wwise Objects Reference for the properties available. For example: @Volume:3
The value of a property.
null A null value. No reference to an object.
string A string value.
number A numerical value.
boolean A boolean value.
imports * array Array of import commands.
imports [...] object 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 example, you can 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 cannot ensure that a reference is set in the required order.
imports[...].importLanguage string Imports the language for the audio file import (taken from the project's defined languages, found in the WPROJ file LanguageList).
imports[...].importLocation any of: Object ID (GUID), name, or path used as root relative object paths.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
imports[...].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 .
imports[...].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...'.
imports[...].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 is imported to the folder Originals\SFX\originalsPath.
imports[...].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 Wwise Objects Reference for the available types.
imports[...].objectType string Specifies the type of 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.
imports[...].notes string The "Notes" field of the created object.
imports[...].audioSourceNotes string The "Notes" field of the created audio source object.
imports[...].switchAssignation string Defines a Switch Group or State Group that is associated to a Switch Container, within the Actor-Mixer Hierarchy only. Also defines which Switch Container's child is assigned to which Switch or State from the associated group. Refer to Tab Delimited Import in the Wwise Help documentation for more information.
imports[...].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.
imports[...].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.
imports[...].regex(^@[:_a-zA-Z0-9]+$) any of: Specifies the value of the property. Refer to Wwise Objects Reference for the properties available.
The value of a property.
null A null value. No reference to an object.
string A string value.
number A numerical value.
boolean A boolean value.
autoAddToSourceControl boolean Determines if Wwise automatically performs a source control Add operation on the imported files. Defaults to true.
autoCheckOutToSourceControl boolean Determines if Wwise automatically performs a source control Checkout operation (when applicable) on the modified files. Defaults to true.

(Required *)

Arguments Schema

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.
The array of return expressions defines which elements of the Wwise object is returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or the Pitch.
return [...] any of: A return expression.
string Specifies one or many of the built-in accessors for Wwise objects. Possible values:
  • id
  • name
  • notes
  • type
  • pluginName
  • shortId
  • classId
  • category
  • filePath
  • workunit
  • parent
  • owner
  • path
  • isPlayable
  • childrenCount
  • totalSize
  • mediaSize
  • objectSize
  • structureSize
  • 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
  • convertedWemFilePath
  • originalFilePath
  • originalRelativeFilePath
  • convertedFilePath
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • duration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
  • isExplicitMute
  • isExplicitSolo
  • isImplicitMute
  • isImplicitSolo
  • isIncluded
  • points
  • stateProperties
  • stateGroups
string Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. 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 .
platform any of: The ID (GUID) or name of the platform. This is an optional argument. When not specified, the current platform is used.
string The name of the platform.
string The id of the platform.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
language any of: The ID (GUID) or name of the language.
string The name of the language.
string The id of the language.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.

Options Schema

Result

Name Type Description
objects * array Array of objects.
objects [...] object 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 example, you can 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 cannot ensure that a reference is set in the required order.
A Wwise object. Use the return options to specify which property is required.
objects[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].name string The name of the object.
objects[...].notes string The notes of the object.
objects[...].type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
objects[...].pluginName string The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in.
objects[...].path string The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
objects[...].parent object The parent of the object in the hierarchy.
objects[...].parent.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].parent.name string The name of the object.
objects[...].owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
objects[...].owner.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].owner.name string The name of the object.
objects[...].isPlayable boolean True if the object can be played in Transport.
objects[...].shortId integer The Short ID of the object.
objects[...].classId integer The class ID of the object.
Unsigned Integer 32-bit. Range: [0,4294967295]
objects[...].category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
objects[...].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 .
objects[...].workunit object The parent Work Unit containing the object. The 'id' and the 'name' is returned.
objects[...].workunit.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].workunit.name string The name of the object.
objects[...].childrenCount number The number of children for the object. Note, this is deprecated. The same result can be obtained with children.count().
objects[...].totalSize integer The amount of space (in bytes) this object and all of its children take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].mediaSize integer The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].objectSize integer The amount of space (in bytes) the meta-data of the object takes up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].structureSize integer The amount of space (in bytes) the meta-data of the object and all of its children take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead.
objects[...].musicTransitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. Note, this is deprecated. The PlaylistRoot reference should be used instead.
objects[...].musicPlaylistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].originalWavFilePath string (DEPRECATED) 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 .
objects[...].originalFilePath string Absolute path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].activeSource object The active source of the sound object.
objects[...].activeSource.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].activeSource.name string The name of the object.
objects[...].convertedWemFilePath string (DEPRECATED) Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].convertedFilePath string Absolute path to the converted file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].soundbankBnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].playbackDuration object The duration root that contains the min and max durations and duration type. Note, this is deprecated. The duration should be used instead. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
objects[...].playbackDuration.playbackDurationMin number The minimum possible time playback can take.
objects[...].playbackDuration.playbackDurationMax number The maximum possible time playback can take.
objects[...].playbackDuration.playbackDurationType string The type of duration.
objects[...].duration 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.
objects[...].duration.min number The minimum possible time playback can take.
objects[...].duration.max number The maximum possible time playback can take.
objects[...].duration.type string The type of duration.
objects[...].maxDurationSource object Audio source with the longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
objects[...].maxDurationSource.id string The ID (GUID) of the audio source object with the longest duration.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
objects[...].audioSourceTrimValues object Range of time for which the audio source is trimmed.
objects[...].audioSourceTrimValues.trimBegin number The time value in seconds of the start trim.
objects[...].audioSourceTrimValues.trimEnd number The time value in seconds of the end trim.
objects[...].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.
objects[...].maxRadiusAttenuation.id string The ID (GUID) of the attenuation object with the largest radius.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].maxRadiusAttenuation.radius number The radius of the attenuation object.
objects[...].audioSourceLanguage object Language associated to the audio source. This only applies to Audio Source objects directly.
objects[...].audioSourceLanguage.id string The ID (GUID) of the Language object to which the Audio Source object is associated.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].audioSourceLanguage.name string The name of the Language object to which the Audio Source object is associated.
objects[...].workunitIsDefault boolean True if the work unit is the default.
objects[...].workunitType string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders have the workunitType "folder". Possible values:
  • folder
  • rootFile
  • nestedFile
objects[...].workunitIsDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved.
objects[...].switchContainerChildContext 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: the properties of the '1st only' checkbox).
objects[...].switchContainerChildContext.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
objects[...].isExplicitSolo boolean Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one.
objects[...].isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
objects[...].isImplicitSolo boolean Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one.
objects[...].isIncluded boolean Whether or not the object is Included. Specify the platform in the options. This takes into consideration the Inclusion status of the object's ancestors.
objects[...].points array This only applies to Curve objects.
An array of points defining a curve.
objects[...].points [...] object A point in the curve.
objects[...].points[...].x * number X coordinate of curve point.
objects[...].points[...].y * number Y coordinate of curve point.
objects[...].points[...].shape * string Shape of the curve segment between this point and the next. Possible values:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
objects[...].stateProperties array An array of state properties to set.
objects[...].stateProperties [...] string The name of the property to set.
objects[...].stateGroups array The State Group objects associated with this object.
objects[...].stateGroups [...] object A State Group object.
objects[...].stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].stateGroups[...].name string The name of the State Group object.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @ specifies the value of the property for the source of override. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
string A string value.
array An array of string values.
number A numeric value.
array An array of numeric values.
boolean A boolean value.
array An array of boolean values.
object An object reference value.
array An object list reference value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string A string value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number A numeric value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean A boolean value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string The name of the object.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object An object reference value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string The name of the object.
files * array The list of imported original files.
files [...] string Absolute path to the original file.
log * array The audio import log.
log [...] object A log entry for audio import.
log[...].severity * string
  • Message: Does not affect the integrity of the current operation.
  • Warning: Might affect the integrity of the current operation.
  • Error: Affects the integrity of the current operation.
  • Fatal Error: Prevents the completion of the current operation.

Possible values:

  • Message
  • Warning
  • Error
  • Fatal Error
log[...].message * string The description message of the log item.
log[...].index number The index of the import command to which the log applies.

(Required *)

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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