Wwise SDK 2024.1.0

按照选项中所作指定针对每个对象执行查询并在查询结果中返回数据。该查询可指定 'waql' 或 'from' 参数以及可选的 'transform' 参数。有关详细信息，请参阅使用 Wwise Authoring Query Language (WAQL) 或查询 Wwise 工程章节。如需了解有关选项的信息，请参阅返回选项章节。

参数

名称	类型	说明
waql	string	使用 WAQL 语言指定查询。有关详细信息，请参阅使用 Wwise Authoring Query Language (WAQL) 章节。
from	one of:	查询的开始点。注意，此项已弃用。应当改用 WAQL 参数。
	object	使用 id 字段指定对象。
	object	使用 search 字段指定对象。
	object	使用 name 字段指定对象。
	object	使用 path 字段指定对象。
	object	使用 ofType 字段指定对象。
	object	使用 query 字段指定对象。
from.id *	array	此数组中包含一系列对象 ID，GUID 或 Short ID (uint32)。
from.id [...]	one of:	GUID 或 Short ID (uint32)。
	string	以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
	object	Wwise 对象的 Short ID 及关联类型。
from.id[...].shortId *	integer	对象的 Short ID。 32 位无符号整数。范围：[0,4294967295]
from.id[...].type *	integer	此语法已被弃用，建议使用 WAQL。Short ID 对应的对象的类型。类型可为 10 (Event)、12 (SwitchGroup)、14 (StateGroup)、17 (EffectPlugin)、18 (SoundBank)、19 (Bus)、20 (AuxBus)、22 (GameParameter)、41 (Trigger) 或 68 (AudioDevicePlugin) 范围：[1,*]
from.search *	array	此数组中包含用于搜索工程的文本标记。
from.search [...]	string	搜索标记。
from.name *	array	此数组中包含一系列唯一对象限定名称。
from.name [...]	string	由类型或 Short ID 限定的对象名称，格式为 type:name 或 Global:shortId。仅支持采用全局唯一名称或 Short Id 的对象类型。例如：Event:Play_Sound_01, Global:245489792
from.path *	array	此数组中包含一系列对象路径。
from.path [...]	string	Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。
from.ofType *	array	此数组中包含一系列对象类型。
from.ofType [...]	string	对象类型。如需查看类型列表，请参阅 Wwise 对象参考章节。
from.query *	array	此数组中包含一系列查询对象 ID。
from.query [...]	string	以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
transform	array	此数组中包含"from" 所返回对象列表联用的序列转换。
transform [...]	one of:	对象转换。
	object	select 转换。
	string	返回唯一对象实例（即不返回重复对象）。可能的值： distinct
	object	使用 range 字段指定对象。
	object	使用 where 字段指定对象。
transform[...].select *	array	此数组中仅包含 1 个选择器。
transform[...].select [...]	string	选择器。结果对象取决于所指定的选择器。可能的值： parent children descendants ancestors referencesTo
transform[...].range *	array	此数组中包含两个用于指定边界索引的数值。使用此项来仅包含部分结果。比如，若设为 [0,100]，则仅包含搜索结果的前 100 个条目。
transform[...].range [...]	number	两个范围限值中的一个。
transform[...].where *	array	此数组中包含两个筛选器结果标记。第一个标记为筛选器谓词。如需查看可用谓词列表，请参阅查询 Wwise 工程章节。第二个标记为谓词的参数。
transform[...].where [...]	any of:	where 语句。
	string	字符串标记。数组中的第一个标记始终为 'where' 谓词名称字符串。第二个标记为对应的参数。
	array	此数组中包含一系列字符串。有关详细信息，请参阅查询 Wwise 工程章节。
transform[...].where[...] [...]	string	'where' 谓语的参数。有关详细信息，请参阅查询 Wwise 工程章节。

参数架构

选项

名称	类型	说明
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 originalRelativeFilePath convertedFilePath originalWavFilePath soundbankBnkFilePath musicTransitionRoot musicPlaylistRoot playbackDuration duration maxDurationSource audioSourceTrimValues maxRadiusAttenuation audioSourceLanguage workunitIsDefault workunitType workunitIsDirty switchContainerChildContext isExplicitMute isExplicitSolo isImplicitMute isImplicitSolo isIncluded points stateProperties stateGroups blendTracks
	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}。

选项架构

结果

名称	类型	说明
return	array	此数组中包含所找到的对象，其属性要与选项中的属性匹配。
return [...]	object	Wwise 对象。 Wwise 对象。使用 return 选项来指定所需的属性。
return[...].id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].name	string	对象的名称。
return[...].notes	string	对象的备注。
return[...].type	string	对象的类型。有关可用类型的详细信息，请参阅 Wwise 对象参考章节。
return[...].pluginName	string	Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。
return[...].path	string	工程根目录下的对象路径。例如：'\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
return[...].parent	object	层级结构下的对象的父对象。
return[...].parent.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].parent.name	string	对象的名称。
return[...].owner	object	对象的所有者。此项适用于其他对象在本地拥有的对象（如自定义效果器、自定义衰减等）。
return[...].owner.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].owner.name	string	对象的名称。
return[...].isPlayable	boolean	若对象可在 Transport 中播放，则返回 true。
return[...].shortId	integer	对象的 Short ID。
return[...].classId	integer	对象的 Class ID。 32 位无符号整数。范围：[0,4294967295]
return[...].category	string	对象的类别。例如：'Actor-Mixer Hierarchy'
return[...].filePath	string	对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].workunit	object	对象所在的父级 Work Unit。返回 'id' 和 'name'。
return[...].workunit.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].workunit.name	string	对象的名称。
return[...].childrenCount	number	对象的子对象数量。注意，此项已弃用。The same result can be obtained with children.count().
return[...].totalSize	integer	此对象及其所有子对象在 SoundBank 中占用的空间大小（字节）。此项不包括 objectSize。注意，需生成 SoundBank 方可确保此数值的准确性。
return[...].mediaSize	integer	此对象及其所有子对象的媒体文件的 Converted Size 总和（字节）。注意，需生成 SoundBank 方可确保此数值的准确性。
return[...].objectSize	integer	对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
return[...].structureSize	integer	对象及其所有子对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
return[...].musicTransitionRoot	object	(DEPRECATED) The music transition root containing all other music transitions recursively. 注意，此项已弃用。The TransitionRoot reference should be used instead.
return[...].musicTransitionRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].musicPlaylistRoot	object	(DEPRECATED) The music playlist root containing all other music playlist items recursively. 此项仅适用于 Music Playlist Container。注意，此项已弃用。The PlaylistRoot reference should be used instead.
return[...].musicPlaylistRoot.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].originalWavFilePath	string	（已弃用）原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].originalFilePath	string	原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].originalRelativeFilePath	string	Relative (from project's Originals Folder) path to the original file. 仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].activeSource	object	声音对象的活跃音频源。
return[...].activeSource.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].activeSource.name	string	对象的名称。
return[...].convertedWemFilePath	string	（已弃用）转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].convertedFilePath	string	转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].soundbankBnkFilePath	string	所生成的 SoundBank 文件的绝对路径，该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅在 Mac 上使用 WAAPI 章节。
return[...].playbackDuration	object	包含最小/最大时长和时长类型的 Duration 根对象。注意，此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
return[...].playbackDuration.playbackDurationMin	number	播放操作可能花费的最小时长。
return[...].playbackDuration.playbackDurationMax	number	播放操作可能花费的最大时长。
return[...].playbackDuration.playbackDurationType	string	时长的类型。
return[...].duration	object	包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
return[...].duration.min	number	播放操作可能花费的最小时长。
return[...].duration.max	number	播放操作可能花费的最大时长。
return[...].duration.type	string	时长的类型。
return[...].maxDurationSource	object	时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
return[...].maxDurationSource.id	string	时长最长的 Audio Source 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].maxDurationSource.trimmedDuration	number	修剪的最长音频源的时长（秒）。
return[...].audioSourceTrimValues	object	修剪的音频源的时间范围。
return[...].audioSourceTrimValues.trimBegin	number	Trim Start 的时间值（秒）。
return[...].audioSourceTrimValues.trimEnd	number	Trim End 的时间值（秒）。
return[...].maxRadiusAttenuation	object	半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
return[...].maxRadiusAttenuation.id	string	半径最长的 Attenuation 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].maxRadiusAttenuation.radius	number	Attenuation 对象的半径。
return[...].audioSourceLanguage	object	与音频源关联的语言。此项仅直接适用于 Audio Source 对象。
return[...].audioSourceLanguage.id	string	与 Audio Source 对象关联的 Language 对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].audioSourceLanguage.name	string	与 Audio Source 对象关联的 Language 对象的名称。
return[...].originalTotalChannelCount	number	The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalNormalChannelCount	number	The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalHeightChannelCount	number	The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalLFEChannelCount	number	The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalAnonymousChannelCount	number	The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalChannelConfig	string	The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalChannelMask	number	The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalSampleRate	number	The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalBitDepth	number	The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalFileSize	number	The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalDataSize	number	The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalSampleCount	number	The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalDuration	number	The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalCodec	string	The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedTotalChannelCount	number	The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedNormalChannelCount	number	The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedHeightChannelCount	number	The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedLFEChannelCount	number	The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedAnonymousChannelCount	number	The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedChannelConfig	string	The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedChannelMask	number	The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedSampleRate	number	The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedBitDepth	number	The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedFileSize	number	The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedDataSize	number	The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedSampleCount	number	The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedDuration	number	The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedCodec	string	The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].workunitIsDefault	boolean	若为 Default Work Unit，则返回 true。
return[...].workunitType	string	Work Unit 的类型。请注意，物理文件夹与 Work Unit 一样，类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值： folder rootFile nestedFile
return[...].workunitIsDirty	boolean	若 Work Unit 或工程（wproj 文件）处于未同步状态（即修改了而没保存），则返回 true。
return[...].switchContainerChildContext	object	与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性（对 Switch Container 来说，与上下文相关）。比如，'1st only' 复选框的属性。
return[...].switchContainerChildContext.id	string	对象的 ID (GUID)。以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].isExplicitMute	boolean	对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
return[...].isExplicitSolo	boolean	对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
return[...].isImplicitMute	boolean	对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
return[...].isImplicitSolo	boolean	对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
return[...].isIncluded	boolean	Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors.
return[...].points	array	此项仅适用于 Curve 对象。此数组中包含定义曲线的控制点。
return[...].points [...]	object	曲线上的控制点。
return[...].points[...].x *	number	曲线控制点的 X 坐标。
return[...].points[...].y *	number	曲线控制点的 Y 坐标。
return[...].points[...].shape *	string	这一控制点和下一控制点之间曲线线段的形状。可能的值： Constant Linear Log3 Log2 Log1 InvertedSCurve SCurve Exp1 Exp2 Exp3
return[...].stateProperties	array	An array of state properties to set.
return[...].stateProperties [...]	string	The name of the property to set.
return[...].stateGroups	array	The State Group objects associated with this object.
return[...].stateGroups [...]	object	A State Group object.
return[...].stateGroups[...].id	string	The ID (GUID) of the State Group object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].stateGroups[...].name	string	The name of the State Group object.
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)*$)	any of:	指定点号分隔的访问器，来构建查询并生成属性值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用，请参阅 Wwise 对象参考章节。
	string	字符串值。
	array	An array of string values.
	number	数字值。
	array	An array of numeric values.
	boolean	布尔值。
	array	An array of boolean values.
	object	对象引用值。
	array	对象列表引用值。
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)$) [...]*	string	字符串值。
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)$) [...]*	number	数字值。
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)$) [...]*	boolean	布尔值。
return[...].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}。
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)*$).name	string	对象的名称。
return[...].regex(^((@?@?[a-zA-Z0-9:_,]+)\|[a-zA-Z,]+$.+$)(\.@?@?[a-zA-Z0-9:_,]+\|[a-zA-Z,]+$.+$)$) [...]*	object	对象引用值。
return[...].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}。
return[...].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.object.get

参数

选项

结果

示例

此页面对您是否有帮助？

需要技术支持？

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