选项

名称	类型	说明
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 originalWavFilePath soundbankBnkFilePath musicTransitionRoot musicPlaylistRoot playbackDuration maxDurationSource audioSourceTrimValues maxRadiusAttenuation audioSourceLanguage workunitIsDefault workunitType workunitIsDirty switchContainerChildContext
	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}。

选项架构

发布

名称	类型	说明
command *	string	所执行的命令 ID。
objects *	array	与所执行命令对应的对象。对象通常为选定对象。按照选项中指定的格式予以返回。若未使用任何对象，则可为空。
objects [...]	object	对象。使用选项来指定所要返回的数据。默认返回 ID 和名称。 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[...].convertedWemFilePath	string	转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 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[...].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[...].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	对象的名称。
platforms *	array	此数组中包含与所执行命令对应的平台。每个平台都表示为 ID (GUID)。
platforms [...]	any of:
	string	对象的名称。
	string	以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。

(必填 *)

发布架构

另请参阅

ak.wwise.ui.commands.execute

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

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅

Wwise SDK 2021.1.14

ak.wwise.ui.commands.executed

选项

发布

另请参阅

此页面对您是否有帮助？

需要技术支持？

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