版本

menu_open
警告:系统已根据您所用大版本 (2023.1.4.8496) 自动跳转至最新文档。若想访问特定版本的文档,请从 Audiokinetic Launcher 下载离线文档,并在 Wwise 设计程序中勾选 Offline Documentation 选项。
Wwise SDK 2023.1.4
ak.wwise.core.profiler.getAudioObjects

在特定性能分析器捕获时间点检索 Audio Object。

参数

名称 类型 说明
time * one of: 指定要在什么时间(毫秒)查询 Audio Object 或通过哪种 Time Cursor 获取时间。User Time Cursor 可由用户操控,Capture Time Cursor 代表当前捕获的最新时间。
integer 范围:[0,*]
string 识别其中一种全局性能分析器光标。可能的值:
  • user
  • capture
busPipelineID integer 要获取 Audio Object 的 Bus 实例的 Pipeline ID。
32 位无符号整数。范围:[0,4294967295]

(必填 *)

参数架构

选项

名称 类型 说明
return array 要针对各个 Audio Object 返回的成员。默认设为 Audio Object ID、Bus Pipeline ID、Instigator Pipeline ID 和 Effect Class ID。
此数组中包含 Audio Object 相关选项。
return [...] string 针对 Audio Object 结构指定其中一个定义的成员。可能的值:
  • busName
  • effectPluginName
  • audioObjectID
  • busPipelineID
  • gameObjectID
  • gameObjectName
  • audioObjectName
  • instigatorPipelineID
  • busID
  • busGUID
  • spatializationMode
  • x
  • y
  • z
  • spread
  • focus
  • channelConfig
  • effectClassID
  • effectIndex
  • metadata
  • rmsMeter
  • peakMeter

选项架构

结果

名称 类型 说明
return * array 此数组中包含一系列 Audio Object。
return [...] object Audio Object。
音频对象。使用 return 选项来指定所需的属性。
return[...].busName string 总线实例的名称。
return[...].effectPluginName string 在其之后捕获 Audio Object 的效果器插件的名称。
return[...].audioObjectID integer Audio Object 的 ID。
64 位无符号整数。范围:[0,18446744073709551615]
return[...].busPipelineID integer Bus 实例的 Pipeline ID。
32 位无符号整数。范围:[0,4294967295]
return[...].gameObjectID integer Bus 实例的 Game Object ID。
64 位无符号整数。范围:[0,18446744073709551615]
return[...].gameObjectName string Bus 实例的 Game Object 名称。
return[...].audioObjectName string Audio Object 的名称。可为空。
return[...].instigatorPipelineID integer 用于创建 Audio Object 的 Instigator 的 Pipeline ID。可为 Bus 实例或 Voice。
32 位无符号整数。范围:[0,4294967295]
return[...].busID integer Bus 的 Short ID。
32 位无符号整数。范围:[0,4294967295]
return[...].busGUID string Bus 的 GUID。
以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。
return[...].spatializationMode integer 空间化模式。使用 Ak3DSpatializationMode 解释数值。
32 位无符号整数。范围:[0,4294967295]
return[...].x number Audio Object 位置的 X 值。
return[...].y number Audio Object 位置的 Y 值。
return[...].z number Audio Object 位置的 Z 值。
return[...].spread number Audio Object 的归一化 Spread 值。
return[...].focus number Audio Object 的归一化 Focus 值。
return[...].channelConfig integer Audio Object 的声道配置。使用 AK::AkChannelConfig::Deserialize 对数值进行反序列化处理。
32 位无符号整数。范围:[0,4294967295]
return[...].effectClassID integer 在其之后捕获 Audio Object 的效果器的 Class ID。若使用 AK_INVALID_UNIQUE_ID 常量,则表示此 Audio Object 是在应用第一个效果器之前捕获的。
32 位无符号整数。范围:[0,4294967295]
return[...].effectIndex integer 在其之后捕获 Audio Object 的效果器的索引。
32 位无符号整数。范围:[0,4294967295]
return[...].metadata array 此数组中列有包含 Audio Object 元数据的对象。
return[...].metadata [...] object 元数据对应的对象。
return[...].metadata[...].metadataClassID * integer 元数据的 Class ID。
32 位无符号整数。范围:[0,4294967295]
return[...].metadata[...].metadataName string 元数据的名称。
return[...].metadata[...].sourceID string 源对象的 ID (GUID)。
return[...].metadata[...].sourceShortID * integer 源对象的 Short ID。
32 位无符号整数。范围:[0,4294967295]
return[...].metadata[...].sourceName string 源对象的名称。
return[...].rmsMeter array 此数组中包含 RMS 电平表的音量值(每个声道对应一个值)。
return[...].rmsMeter [...] number 声道的音量值 (dB)。
return[...].peakMeter array 此数组中包含 Peak 电平表的音量值(每个声道对应一个值)。
return[...].peakMeter [...] number 声道的音量值 (dB)。

(必填 *)

结果架构

另请参阅

示例

有关 Wwise Authoring API 的详细信息,请参阅 使用 Wwise Authoring API(WAAPI) 章节。


此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅