Wwise SDK 2022.1.17

创建 Wwise 对象并导入音频文件。此函数使用 Audio File Importer 中 Tab Delimited import 提供的同一导入处理器。函数会返回包含所有创建、替换或重用的对象的数组。使用选项来指定如何返回对象。有关详细信息，请参阅导入音频文件和创建架构章节。

参数

名称	类型	说明
importOperation	string	决定如何导入并创建对象。对于创建的各个对象：- createNew：创建新的对象；在可能的情况下赋予对象以所需名称，否则使用新的唯一名称。- useExisting：使用现有对象（如有），更新给定属性；否则，创建新的对象。该项为默认值。- replaceExisting：创建新的对象；若存在同名的现有对象，则将现有对象销毁。可能的值： createNew useExisting replaceExisting
default	object	"imports" 中各个条目的默认值。使用此对象来避免重复导入各个元素的通用属性。
default.importLanguage	string	导入音频文件导入操作所用的语言（基于工程定义的语言，可在 WPROJ 文件的 LanguageList 中找到）。
default.importLocation	any of:	用作根相对对象路径的对象 ID (GUID)、名称或路径。
	string	由类型或 Short ID 限定的对象名称，格式为 type:name 或 Global:shortId。仅支持采用全局唯一名称或 Short Id 的对象类型。例如：Event:Play_Sound_01, Global:245489792
	string	以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
	string	Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。
default.audioFile	string	所要导入的媒体文件的路径。此路径必须可通过 Wwise 访问。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
default.audioFileBase64	string	Base64 编码的 WAV 音频文件数据，按照相对于 Originals 文件夹的目标文件路径导入，采用竖线分隔。例如：'MySound.wav\|UklGRu...'。
default.originalsSubFolder	string	指定要替换哪个 'originals' 子文件夹中导入的音频文件。此文件夹与通常要导入文件的 'originals' 文件夹相对。例如：若导入 SFX，则将音频文件导入到 Originals\SFX\originalsPath 文件夹。
default.objectPath	string	所要创建的对象的路径和名称。路径使用反斜杠，可为绝对路径或相对路径。可在名称之前指定对象类型。例如： \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound。有关可用类型的信息，请参阅 Wwise 对象参考章节。
default.objectType	string	指定要在导入音频文件时创建的对象的类型。此类型也可直接在 objectPath 中指定。有关可用类型的信息，请参阅 Wwise 对象参考章节。
default.notes	string	所创建对象的 "Notes" 字段。
default.audioSourceNotes	string	所创建 Audio Source 对象的 "Notes" 字段。
default.switchAssignation	string	定义与 Switch Container 关联的 Switch Group 或 State Group（仅 Actor-Mixer Hierarchy 下）。同时定义 Switch Container 的子对象与关联分组中的 Switch 或 State 的指派关系。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
default.event	string	定义要针对所导入对象创建的 Event 的路径和名称。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
default.dialogueEvent	string	定义要针对所导入对象创建的 Dialogue Event 的路径和名称。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
default.regex(^@[:_a-zA-Z0-9]+$)	any of:	指定 Wwise 对象属性和它的值。属性名称带有 @ 前缀。有关可用属性的信息，请参阅 Wwise 对象参考章节。例如：@Volume:3。属性的值。
	null	空值。没有对对象的引用。
	string	字符串值。
	number	数字值。
	boolean	布尔值。
imports *	array	此数组中包含一系列“导入”命令。
imports [...]	object	“导入”命令。此对象的成员与 "default" 的成员结合使用。在这当中，优先应用此对象的成员。除所列属性外，还可使用 @Property 设置 wobject 属性和引用。比如，我们可以通过添加 @Volume 属性来设置音量。不应设置受其他引用约束的引用（比如 Switch Container 的 State/Switch，其被限定为 State/Switch Group 的子对象），因为 WAAPI 无法保证按照所需顺序设置此类引用。
imports[...].importLanguage	string	导入音频文件导入操作所用的语言（基于工程定义的语言，可在 WPROJ 文件的 LanguageList 中找到）。
imports[...].importLocation	any of:	用作根相对对象路径的对象 ID (GUID)、名称或路径。
	string	由类型或 Short ID 限定的对象名称，格式为 type:name 或 Global:shortId。仅支持采用全局唯一名称或 Short Id 的对象类型。例如：Event:Play_Sound_01, Global:245489792
	string	以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
	string	Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。
imports[...].audioFile	string	所要导入的媒体文件的路径。此路径必须可通过 Wwise 访问。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
imports[...].audioFileBase64	string	Base64 编码的 WAV 音频文件数据，按照相对于 Originals 文件夹的目标文件路径导入，采用竖线分隔。例如：'MySound.wav\|UklGRu...'。
imports[...].originalsSubFolder	string	指定要替换哪个 'originals' 子文件夹中导入的音频文件。此文件夹与通常要导入文件的 'originals' 文件夹相对。例如：若导入 SFX，则将音频文件导入到 Originals\SFX\originalsPath 文件夹。
imports[...].objectPath *	string	所要创建的对象的路径和名称。路径使用反斜杠，可为绝对路径或相对路径。可在名称之前指定对象类型。例如： \\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound。有关可用类型的信息，请参阅 Wwise 对象参考章节。
imports[...].objectType	string	指定要在导入音频文件时创建的对象的类型。此类型也可直接在 objectPath 中指定。有关可用类型的信息，请参阅 Wwise 对象参考章节。
imports[...].notes	string	所创建对象的 "Notes" 字段。
imports[...].audioSourceNotes	string	所创建 Audio Source 对象的 "Notes" 字段。
imports[...].switchAssignation	string	定义与 Switch Container 关联的 Switch Group 或 State Group（仅 Actor-Mixer Hierarchy 下）。同时定义 Switch Container 的子对象与关联分组中的 Switch 或 State 的指派关系。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
imports[...].event	string	定义要针对所导入对象创建的 Event 的路径和名称。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
imports[...].dialogueEvent	string	定义要针对所导入对象创建的 Dialogue Event 的路径和名称。有关详细信息，请参阅 Wwise Help 文档中的 Tab Delimited Import 部分。
imports[...].regex(^@[:_a-zA-Z0-9]+$)	any of:	指定属性的值。有关可用属性的信息，请参阅 Wwise 对象参考章节。属性的值。
	null	空值。没有对对象的引用。
	string	字符串值。
	number	数字值。
	boolean	布尔值。
autoAddToSourceControl	boolean	决定是否自动对通过版本控制系统导入的文件执行 Add 或 Checkout 操作。默认设为 false。

(必填 *)

参数架构

选项

名称	类型	说明
return	array	指定要为每个对象返回什么内容。有关可用属性和引用的详细信息，请参阅 Wwise 对象参考章节。此数组中包含一系列 return 表达式，用于定义所要返回的 Wwise 对象元素。这可能包括内置访问器（如名称或 ID）或对象属性（如 Volume 或 Pitch）。
return [...]	any of:	return 表达式。
	string	为 Wwise 对象指定一个或多个内置访问器。可能的值： 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 convertedFilePath originalWavFilePath soundbankBnkFilePath musicTransitionRoot musicPlaylistRoot playbackDuration duration maxDurationSource audioSourceTrimValues maxRadiusAttenuation audioSourceLanguage workunitIsDefault workunitType workunitIsDirty switchContainerChildContext isExplicitMute isExplicitSolo isImplicitMute isImplicitSolo isIncluded points
	string	指定一个或多个点号分隔的访问器，来构建查询并生成数值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。参阅 Wwise 对象参考章节。
platform	any of:	平台的 ID (GUID) 或名称。此项为可选参数。若不作任何指定，则使用当前平台。
	string	平台的名称。
	string	平台的 ID。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
language	any of:	语言的 ID (GUID) 或名称。
	string	语言的名称。
	string	语言的 ID。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。

选项架构

结果

名称	类型	说明
objects	array	此数组中包含一系列对象。
objects [...]	object	“导入”命令。此对象的成员与 "default" 的成员结合使用。在这当中，优先应用此对象的成员。除所列属性外，还可使用 @Property 设置 wobject 属性和引用。比如，我们可以通过添加 @Volume 属性来设置音量。不应设置受其他引用约束的引用（比如 Switch Container 的 State/Switch，其被限定为 State/Switch Group 的子对象），因为 WAAPI 无法保证按照所需顺序设置此类引用。 Wwise 对象。使用 return 选项来指定所需的属性。
objects[...].id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].name	string	对象的名称。
objects[...].notes	string	对象的备注。
objects[...].type	string	对象的类型。有关可用类型的详细信息，请参阅 Wwise 对象参考章节。
objects[...].pluginName	string	Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。
objects[...].path	string	工程根目录下的对象路径。例如：'\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
objects[...].parent	object	层级结构下的对象的父对象。
objects[...].parent.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].parent.name	string	对象的名称。
objects[...].owner	object	对象的所有者。此项适用于其他对象在本地拥有的对象（如自定义效果器、自定义衰减等）。
objects[...].owner.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].owner.name	string	对象的名称。
objects[...].isPlayable	boolean	若对象可在 Transport 中播放，则返回 true。
objects[...].shortId	integer	对象的 Short ID。
objects[...].classId	integer	对象的 Class ID。 32 位无符号整数。范围：[0,4294967295]
objects[...].category	string	对象的类别。例如：'Actor-Mixer Hierarchy'
objects[...].filePath	string	对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].workunit	object	对象所在的父级 Work Unit。返回 'id' 和 'name'。
objects[...].workunit.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].workunit.name	string	对象的名称。
objects[...].childrenCount	number	对象的子对象数量。
objects[...].totalSize	integer	此对象及其所有子对象在 SoundBank 中占用的空间大小（字节）。此项不包括 objectSize。注意，需生成 SoundBank 方可确保此数值的准确性。
objects[...].mediaSize	integer	此对象及其所有子对象的媒体文件的 Converted Size 总和（字节）。注意，需生成 SoundBank 方可确保此数值的准确性。
objects[...].objectSize	integer	对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
objects[...].structureSize	integer	对象及其所有子对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
objects[...].musicTransitionRoot	object	包含其他所有以递归方式获取的 Music Transition 的 Music Transition 根对象。
objects[...].musicTransitionRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].musicPlaylistRoot	object	包含其他所有以递归方式获取的 Music Playlist 条目的 Music Playlist 根对象。此项仅适用于 Music Playlist Container。
objects[...].musicPlaylistRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].originalWavFilePath	string	（已弃用）原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].originalFilePath	string	原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].activeSource	object	声音对象的活跃音频源。
objects[...].activeSource.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].activeSource.name	string	对象的名称。
objects[...].convertedWemFilePath	string	（已弃用）转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].convertedFilePath	string	转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].soundbankBnkFilePath	string	所生成的 SoundBank 文件的绝对路径，该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
objects[...].playbackDuration	object	包含最小/最大时长和时长类型的 Duration 根对象。注意，此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
objects[...].playbackDuration.playbackDurationMin	number	播放操作可能花费的最小时长。
objects[...].playbackDuration.playbackDurationMax	number	播放操作可能花费的最大时长。
objects[...].playbackDuration.playbackDurationType	string	时长的类型。
objects[...].duration	object	包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
objects[...].duration.min	number	播放操作可能花费的最小时长。
objects[...].duration.max	number	播放操作可能花费的最大时长。
objects[...].duration.type	string	时长的类型。
objects[...].maxDurationSource	object	时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
objects[...].maxDurationSource.id	string	时长最长的 Audio Source 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].maxDurationSource.trimmedDuration	number	修剪的最长音频源的时长（秒）。
objects[...].audioSourceTrimValues	object	修剪的音频源的时间范围。
objects[...].audioSourceTrimValues.trimBegin	number	Trim Start 的时间值（秒）。
objects[...].audioSourceTrimValues.trimEnd	number	Trim End 的时间值（秒）。
objects[...].maxRadiusAttenuation	object	半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
objects[...].maxRadiusAttenuation.id	string	半径最长的 Attenuation 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].maxRadiusAttenuation.radius	number	Attenuation 对象的半径。
objects[...].audioSourceLanguage	object	与音频源关联的语言。此项仅直接适用于 Audio Source 对象。
objects[...].audioSourceLanguage.id	string	与 Audio Source 对象关联的 Language 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].audioSourceLanguage.name	string	与 Audio Source 对象关联的 Language 对象的名称。
objects[...].workunitIsDefault	boolean	若为 Default Work Unit，则返回 true。
objects[...].workunitType	string	Work Unit 的类型。请注意，物理文件夹与 Work Unit 一样，类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值： folder rootFile nestedFile
objects[...].workunitIsDirty	boolean	若 Work Unit 或工程（wproj 文件）处于未同步状态（即修改了而没保存），则返回 true。
objects[...].switchContainerChildContext	object	与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性（对 Switch Container 来说，与上下文相关）。比如，'1st only' 复选框的属性。
objects[...].switchContainerChildContext.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].isExplicitMute	boolean	对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
objects[...].isExplicitSolo	boolean	对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
objects[...].isImplicitMute	boolean	对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
objects[...].isImplicitSolo	boolean	对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
objects[...].isIncluded	boolean	Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors.
objects[...].points	array	此项仅适用于 Curve 对象。此数组中包含定义曲线的控制点。
objects[...].points [...]	object	曲线上的控制点。
objects[...].points[...].x *	number	曲线控制点的 X 坐标。
objects[...].points[...].y *	number	曲线控制点的 Y 坐标。
objects[...].points[...].shape *	string	这一控制点和下一控制点之间曲线线段的形状。可能的值： Constant Linear Log3 Log2 Log1 InvertedSCurve SCurve Exp1 Exp2 Exp3
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$)	any of:	指定点号分隔的访问器，来构建查询并生成属性值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用，请参阅 Wwise 对象参考章节。
	string	字符串值。
	number	数字值。
	boolean	布尔值。
	object	对象引用值。
	array	对象列表引用值。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$).id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$).name	string	对象的名称。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)$) [...]*	object	对象引用值。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$)[...].id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(\.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$)[...].name	string	对象的名称。

结果架构

另请参阅

示例

有关 Wwise Authoring API 的详细信息，请参阅使用 Wwise Authoring API（WAAPI）章节。

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅

Wwise SDK

ak.wwise.core.audio.import

参数

选项

结果

另请参阅

示例

此页面对您是否有帮助？

需要技术支持？

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