版本
menu_open
Wwise SDK 2019.1.11
ak.wwise.core.audio.import Arguments Schema

Schema

{
"additionalProperties": false,
"required": [
"imports"
],
"type": "object",
"properties": {
"default": {
"additionalProperties": false,
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
],
"description": "Specify a Wwise object property and its value. Property names are prefixed with @. Refer to \\ref wobjects_index for the properties available. For example: \\@Volume:3\\n The value of a property."
}
},
"type": "object",
"description": "Default values for each item in \"imports\". Use this object to avoid repeating common properties of every imported element.",
"properties": {
"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."
},
"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."
},
"importLocation": {
"anyOf": [
{
"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_]*$",
"type": "string",
"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. Ex: Event:Play_Sound_01"
},
{
"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}\\}$",
"type": "string",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"pattern": "^\\\\",
"type": "string",
"description": "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."
}
],
"description": "Object ID (GUID), name, or path used as root relative object paths."
},
"audioFileBase64": {
"pattern": "^(.+\\.wav\\|((?:[A-Za-z0-9\\+\\/]{4})*(?:[A-Za-z0-9\\+\\/]{2}==|[A-Za-z0-9\\+\\/]{3}=))+)$",
"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...'."
},
"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: \\verbatim \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\<Random Container>MyContainer\\\\<Sound>MySound. \\endverbatim Refer to \\ref wobjects_index for the available types."
},
"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."
},
"audioSourceNotes": {
"type": "string",
"description": "The \"Notes\" field of the created audio source object."
},
"notes": {
"type": "string",
"description": "The \"Notes\" field of the created object."
},
"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. Refer to \\ref wobjects_index for the available types."
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList)."
}
}
},
"imports": {
"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.",
"required": [
"objectPath"
],
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
],
"description": "Specify the value of the property. Refer to \\ref wobjects_index for the properties available.\\n The value of a property."
}
},
"additionalProperties": false,
"type": "object",
"properties": {
"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."
},
"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."
},
"importLocation": {
"anyOf": [
{
"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_]*$",
"type": "string",
"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. Ex: Event:Play_Sound_01"
},
{
"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}\\}$",
"type": "string",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"pattern": "^\\\\",
"type": "string",
"description": "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."
}
],
"description": "Object ID (GUID), name, or path used as root relative object paths."
},
"audioFileBase64": {
"pattern": "^(.+\\.wav\\|((?:[A-Za-z0-9\\+\\/]{4})*(?:[A-Za-z0-9\\+\\/]{2}==|[A-Za-z0-9\\+\\/]{3}=))+)$",
"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...'."
},
"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: \\verbatim \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\<Random Container>MyContainer\\\\<Sound>MySound. \\endverbatim Refer to \\ref wobjects_index for the available types."
},
"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."
},
"audioSourceNotes": {
"type": "string",
"description": "The \"Notes\" field of the created audio source object."
},
"notes": {
"type": "string",
"description": "The \"Notes\" field of the created object."
},
"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. Refer to \\ref wobjects_index for the available types."
},
"audioFile": {
"type": "string",
"description": "Path to media file to import. This path must be accessible from Wwise. For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"importLanguage": {
"type": "string",
"description": "Import language for audio file import (from among the project's defined languages, found in the WPROJ file LanguageList)."
}
}
},
"type": "array",
"description": "Array of import commands."
},
"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."
},
"importOperation": {
"enum": [
"createNew",
"useExisting",
"replaceExisting"
],
"type": "string",
"description": "Determines how import object creation is performed. For each object created:\n- createNew: will create a new object; the object will be given the desired name if possible, otherwise a new unique name will be used.\n- useExisting: will use the object if it exists, updating the specified properties; otherwise it will create a new object. This is the default value.\n- replaceExisting: will create a new object; if an existing object has the same name then the existing object is destroyed."
}
}
}

此页面对您是否有帮助？

需要技术支持？

仍有疑问？或者问题？需要更多信息？欢迎联系我们，我们可以提供帮助！

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目，我们帮您快速入门，不带任何附加条件！

开始 Wwise 之旅