CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
Editor Profiler（编辑器内分析器）
profiler4u_overview_capture.png
本功能可以用于在Unity编辑器内对CRIWARE插件的运行状态进行分析。
用户可通过在编辑器内使用此功能来实时监视插件的CPU占用率、内存使用量、播放音频数量等数值。

  • 关于CRI Atom Craft Profiler

    本SDK所包含的创作工具CRI Atom Craft中也内建了分析功能。
    与在Unity编辑器内使用的Editor Profiler功能相比，两者各有其优点。用户可根据目的进行区分使用。

    CRI Atom Craft Profiler
    • 具有完备的Cue播放事件的时间线显示、详细事件列表、事件记录存取等功能
    • 可同时使用Atom Tool的游戏内预览(In-Game Preview)功能

    Editor Profiler
    • 状态分析可在Unity编辑器内与应用制作同时进行
    • 由于使用C#脚本实现，本功能可由用户自行扩充增强

    CRI Atom Craft Profiler相关的内容请参阅CRI Atom Tool用户手册。

使用方法

本功能需要在Unity编辑器内导入CRIWARE Unity Plug-in的基础上使用。
使用步骤如下：
  1. 从Unity的[Window]->[CRIWARE]->[CRI Profiler]菜单中打开CRI Profiler窗口

    profiler4u_menu.png

  2. 在CRIWARE Library Initializer的“Uses In Game Preview”中选择Enable
    在旧版本中是通过选中复选框来启用。

    profiler4u_enable_dropdown.png

    旧版本
    profiler4u_enable_checkbox.png

  3. 在Unity编辑器应用执行中的状态下点击CRI Profiler窗口的Start按钮，启动Profiler；
    或者启用“Start with Player”复选框（参照 GUI(图形界面)说明 ）的状态下执行Unity编辑器

    profiler4u_start_button.png

GUI(图形界面)说明

以下将介绍CRI Profiler窗口的各组成部分。

profiler4u_gui_layout.png
CRI Profiler窗口的GUI布局

Start / Stop / Pause按钮

控制分析处理的开始、停止或暂停。
以上按钮仅在Unity编辑器应用执行期间有效。

Configuration

可以更改编辑器Profiler的各项设置。
  • Start with Player复选框：启用时，Profiler将在Unity编辑器开始执行的同时自动启动。

  • Pause with Player复选框：启用时，Unity编辑器一旦暂停/取消暂停，Profiler也会同时暂停/取消暂停。

  • Save Log File：将捕获的性能分析信息保存到文件中。启用时，则可以指定文件的保存目标。

  • Experimental：实验性功能（后述）
    ※ 此功能今后可能更改。

性能(Performance)

此为CRIWARE插件执行状态中与性能相关的项目。
  • CPU Usage：CRIWARE组件的CPU使用量及其变化的图形

  • Number of Voices：目前播放中的Voice数量/最大可播放的Voice数，以及播放Voice数的变化图形

  • Standard Pool Usage / HCA-MX Pool Usage：各音频格式所被分配的Voice池大小和其使用量的仪表
    ※ Voice池大小为0时，最大值显示为“-”
    ※ Voice池使用量在信息未被更新时显示为“-”
    ※ 目前的设计上、设置为“Play On Start”的音源在应用刚启动后并不会反映到Voice池使用量的数值上（显示为“-”）。启动后同一Voice池的任何音频开始或停止播放时则会更新为正确数值。

  • Atom Memory Usage / FS Memory Usage：CRIWARE Atom/File System组件的内存使用量

  • Streaming Usage：使用串流播放的Voice数与合计比特率

  • Last Played：最后播放的Voice的Cue名

Playing

按播放开始的先后次序列举显示播放中的Voice的Cue名。

响度(Loudness)

显示响度信息。

Peak / RMS

显示MasterOut(BUS0)的每个声道的Level信息。

显示时间轴

profiler4u_timeline.png

于时间轴上显示Voice播放事件。
可以使用左上方的“Timeline(时间轴)”按钮启用/禁用此功能。
可以使用“Auto Scroll”按钮切换时间轴显示是否自动滚动到末尾。
单击显示播放事件的块时，Cue名称、Cue Sheet名称和播放时间将显示于上方的工具栏中。

显示事件日志

profiler4u_eventlog.png

显示Voice播放事件列表。
可以使用左上方的“Event Log”按钮启用/禁用此功能。
可以通过单击“Clear Log”按钮清除显示中的日志。
通过“Open Log File”，可以读取 Configuration 指定的日志保存文件并显示播放事件。


实验性功能：Remote Profiling

Remote Profiling（远程分析）功能可以用于对已构建的应用程序进行分析。
执行本功能后，Profiler可以连接到编辑器所在PC或者同一网络上的其他设备上的应用程序。

profiler4u_experimental.png

使用步骤

  1. 启用CRI Profiler窗口[Configuration]->[Experimental]下的“Remote Profiling”复选框

  2. 在“IP Address”文字字段内设置分析对象设备的IP地址

  3. 在设备上启动对象应用程序

  4. 点击CRI Profiler窗口Start按钮，启动Profiler
注意
需要有效化对象应用程序的游戏内预览功能。
Unity编辑器不需要处于执行状态。
本功能为实验性功能，未来本功能内容有可能更改。


Unity控制台输出

编辑器Profiler在启动和停止时会在Unity控制台中输出以下日志内容。

profiler4u_start_log.png

profiler4u_stop_log.png

另外，在沒有有效化“Uses In Game Preview”，或者（使用Remote Profiling时）网络连接不稳定等原因，Profiler无法连接到应用时，以下信息会被输出到Unity控制台，并再次尝试连接：

profiler4u_connection_error.png