选项

名称	类型	说明
infoFile	boolean	在响应中嵌入 JSON SoundBank 信息文件。
bankData	boolean	在响应中嵌入 base64 SoundBank 数据。
pluginInfo	boolean	在响应中嵌入 JSON PluginInfo 文件。
return	array	要为所生成 SoundBank 返回的数据。有关可用属性的详细信息，请参阅 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 originalWavFilePath soundbankBnkFilePath musicTransitionRoot musicPlaylistRoot playbackDuration maxDurationSource audioSourceTrimValues maxRadiusAttenuation audioSourceLanguage workunitIsDefault workunitType workunitIsDirty switchContainerChildContext
	string	指定一个或多个点号分隔的访问器，来构建查询并生成数值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。参阅 Wwise 对象参考章节。

选项架构

发布

名称	类型	说明
soundbank	object	生成的 SoundBank。使用 return 选项获取特定细节。 Wwise 对象。使用 return 选项来指定所需的属性。
soundbank.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.name	string	对象的名称。
soundbank.notes	string	对象的备注。
soundbank.type	string	对象的类型。有关可用类型的详细信息，请参阅 Wwise 对象参考章节。
soundbank.pluginName	string	Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。
soundbank.path	string	工程根目录下的对象路径。例如：'\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
soundbank.parent	object	层级结构下的对象的父对象。
soundbank.parent.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.parent.name	string	对象的名称。
soundbank.owner	object	对象的所有者。此项适用于其他对象在本地拥有的对象（如自定义效果器、自定义衰减等）。
soundbank.owner.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.owner.name	string	对象的名称。
soundbank.isPlayable	boolean	若对象可在 Transport 中播放，则返回 true。
soundbank.shortId	integer	对象的 Short ID。
soundbank.classId	integer	对象的 Class ID。 32 位无符号整数。范围：[0,4294967295]
soundbank.category	string	对象的类别。例如：'Actor-Mixer Hierarchy'
soundbank.filePath	string	对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
soundbank.workunit	object	对象所在的父级 Work Unit。返回 'id' 和 'name'。
soundbank.workunit.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.workunit.name	string	对象的名称。
soundbank.childrenCount	number	对象的子对象数量。
soundbank.totalSize	integer	此对象及其所有子对象在 SoundBank 中占用的空间大小（字节）。此项不包括 objectSize。注意，需生成 SoundBank 方可确保此数值的准确性。
soundbank.mediaSize	integer	此对象及其所有子对象的媒体文件的 Converted Size 总和（字节）。注意，需生成 SoundBank 方可确保此数值的准确性。
soundbank.objectSize	integer	对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
soundbank.structureSize	integer	对象及其所有子对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
soundbank.musicTransitionRoot	object	包含其他所有以递归方式获取的 Music Transition 的 Music Transition 根对象。
soundbank.musicTransitionRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.musicPlaylistRoot	object	包含其他所有以递归方式获取的 Music Playlist 条目的 Music Playlist 根对象。此项仅适用于 Music Playlist Container。
soundbank.musicPlaylistRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.originalWavFilePath	string	原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
soundbank.convertedWemFilePath	string	转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
soundbank.soundbankBnkFilePath	string	所生成的 SoundBank 文件的绝对路径，该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
soundbank.playbackDuration	object	包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
soundbank.playbackDuration.playbackDurationMin	number	播放操作可能花费的最小时长。
soundbank.playbackDuration.playbackDurationMax	number	播放操作可能花费的最大时长。
soundbank.playbackDuration.playbackDurationType	string	时长的类型。
soundbank.maxDurationSource	object	时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
soundbank.maxDurationSource.id	string	时长最长的 Audio Source 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.maxDurationSource.trimmedDuration	number	修剪的最长音频源的时长（秒）。
soundbank.audioSourceTrimValues	object	修剪的音频源的时间范围。
soundbank.audioSourceTrimValues.trimBegin	number	Trim Start 的时间值（秒）。
soundbank.audioSourceTrimValues.trimEnd	number	Trim End 的时间值（秒）。
soundbank.maxRadiusAttenuation	object	半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
soundbank.maxRadiusAttenuation.id	string	半径最长的 Attenuation 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.maxRadiusAttenuation.radius	number	Attenuation 对象的半径。
soundbank.audioSourceLanguage	object	与音频源关联的语言。此项仅直接适用于 Audio Source 对象。
soundbank.audioSourceLanguage.id	string	与 Audio Source 对象关联的 Language 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.audioSourceLanguage.name	string	与 Audio Source 对象关联的 Language 对象的名称。
soundbank.workunitIsDefault	boolean	若为 Default Work Unit，则返回 true。
soundbank.workunitType	string	Work Unit 的类型。请注意，物理文件夹与 Work Unit 一样，类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值： folder rootFile nestedFile
soundbank.workunitIsDirty	boolean	若 Work Unit 或工程（wproj 文件）处于未同步状态（即修改了而没保存），则返回 true。
soundbank.switchContainerChildContext	object	与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性（对 Switch Container 来说，与上下文相关）。比如，'1st only' 复选框的属性。
soundbank.switchContainerChildContext.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$)	any of:	指定点号分隔的访问器，来构建查询并生成属性值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用，请参阅 Wwise 对象参考章节。
	string	字符串值。
	number	数字值。
	boolean	布尔值。
	object	对象引用值。
	array	对象列表引用值。
soundbank.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}。
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$).name	string	对象的名称。
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)$) [...]*	object	对象引用值。
soundbank.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}。
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)\|[a-zA-Z]+$.+$)(.@?@?[a-zA-Z0-9:_]+\|[a-zA-Z]+$.+$)*$)[...].name	string	对象的名称。
platform	object	针对该平台生成了 SoundBank。
language	object	针对该语言生成了 SoundBank。仅在针对特定语言生成 SoundBank 时显示。
error	string	错误消息（如出现错误）。仅在出现错误时显示。
bankData	object	此 SoundBank 数据对象包含 base64 编码的实际数据及数据大小。
bankData.data	string	base64 编码的 SoundBank 数据。
bankData.size	integer	编码后 SoundBank 数据的大小。
bankInfo	array	SoundBank 的所有信息。
bankInfo [...]	object	SoundBank 信息。
bankInfo[...].Id	string	生成的 SoundBank 的 Short ID（以字符串形式编码）。
bankInfo[...].GUID	string	生成的 SoundBank 的 GUID。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
bankInfo[...].ObjectPath	string	工程中的对象路径。
bankInfo[...].Language	string	此 SoundBank 中所用语言的名称。
bankInfo[...].ShortName	string	SoundBank 的名称。
bankInfo[...].Path	string	SoundBank 的文件名。
bankInfo[...].IncludedEvents	array	此 SoundBank 中包含的所有 Event 及其信息。
bankInfo[...].IncludedEvents [...]	object	Event 信息。
bankInfo[...].IncludedEvents[...].Id	string	Event 的 Short ID。
bankInfo[...].IncludedEvents[...].Name	string	Event 的名称。
bankInfo[...].IncludedEvents[...].GUID	string	Event 的 GUID。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
bankInfo[...].IncludedEvents[...].MaxAttenuation	string	Event 的最大衰减（浮点值）。
bankInfo[...].IncludedEvents[...].DurationType	string	时长的类型。可能的值：OneShot、Unknown、Infinite、Mixed。
bankInfo[...].IncludedEvents[...].DurationMin	string	时长的最小值（浮点值）。
bankInfo[...].IncludedEvents[...].DurationMax	string	时长的最大值（浮点值）。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles	array	该数组中包含此 SoundBank 或 Event 所用的全部流播放文件。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles [...]	object	Referenced Streamed File 条目。 Media File 引用。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Id	string	媒体的 Short ID。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Language	string	此媒体所用的语言名称。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].ShortName	string	原始文件的文件名。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Path	string	转码后的媒体相对于缓存文件夹的路径。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].PrefetchSize	string	Prefetch Size 的字节大小。
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].UseDeviceMemory	string	媒体是否需要设备内存。可能的值： true false
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles	array	此数组中包含 SoundBank 或 Event 内弃用的媒体。若针对流播放文件使用 Prefetch，则将在此处列出 Prefetch Size。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles [...]	object	Excluded Streamed File 条目。 Media File 引用。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Id	string	媒体的 Short ID。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Language	string	此媒体所用的语言名称。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].ShortName	string	原始文件的文件名。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Path	string	转码后的媒体相对于缓存文件夹的路径。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].PrefetchSize	string	Prefetch Size 的字节大小。
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].UseDeviceMemory	string	媒体是否需要设备内存。可能的值： true false
PluginInfo	object	PluginInfo 文件信息。
PluginInfo.Project	string	Wwise 工程的名称。
PluginInfo.Platform	string	平台的名称。
PluginInfo.BasePlatform	string	当前平台所基于的基础平台。
PluginInfo.Plugins	array	此数组中包含一系列插件。
PluginInfo.Plugins [...]	object	插件信息。
PluginInfo.Plugins[...].Name	string	插件的 Display Name。
PluginInfo.Plugins[...].ID	string	插件的 Short ID。
PluginInfo.Plugins[...].DLL	string	插件 DLL 的名称。

发布架构

另请参阅

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

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅

Wwise SDK 2021.1.14

ak.wwise.core.soundbank.generated

选项

发布

另请参阅

此页面对您是否有帮助？

需要技术支持？

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