# 订阅音频卡顿事件（ArkTS）

#### 接口说明

API接口的具体使用说明（参数使用限制、具体取值范围等）请参考@ohos.hiviewdfx.hiAppEvent (应用事件打点)ArkTS API文档。

| 接口名 | 描述 |
| --- | --- |
| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
| removeWatcher(watcher: Watcher): void | 移除应用事件观察者，以移除对应用事件的订阅。 |

#### 开发步骤

以实现对应用音频播放触发丢帧生成的音频卡顿事件订阅为例，说明开发步骤。

1.  编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，添加系统事件的订阅。
    
    ```
    import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
    
    hiAppEvent.addWatcher({
       // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
       name: "watcher",
       // 开发者可以订阅感兴趣的系统事件，此处是订阅了应用音频卡顿事件
       appEventFilters: [
         {
           domain: hiAppEvent.domain.OS,
           names: [hiAppEvent.event.AUDIO_JANK_FRAME]
         }
       ],
       // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
       onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
         hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
         for (const eventGroup of appEventGroups) {
           // 开发者可以根据事件集合中的事件名称区分不同的系统事件
           hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
           for (const eventInfo of eventGroup.appEventInfos) {
             // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
             hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo=${JSON.stringify(eventInfo)}`);
           }
         }
       }
     });
    ```
    
2.  编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加一个模拟写入音频数据的回调函数normalCallback，在该回调中模拟卡顿主动返回INVALID（不送数据）来触发卡顿故障事件。
    
    ```
    import { audio } from '@kit.AudioKit';
    let g_invalidCount = 0;
    function normalCallback(buffer: ArrayBuffer) {
      if (g_invalidCount > 0) {
        g_invalidCount--;
        return audio.AudioDataCallbackResult.INVALID;
      }
      //在此添加写数据逻辑
      return audio.AudioDataCallbackResult.VALID;
    }
    ```
    
3.  编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加一个卡顿触发按钮，改变INVALID返回次数，模拟相应音频卡顿。
    
    ```
    Row() {
      Button("卡顿").onClick(async () => {
        g_invalidCount = 30;
      })
    }
    ```
    
4.  编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，在创建AudioRender实例时，进行耗时操作回调
    
    ```
    audio.createAudioRenderer(audioRendererOptions, (err, renderer) => { // 创建AudioRenderer实例
      if (!err) {
        console.info(`${TAG}: creating AudioRenderer success`);
        this.renderModel = renderer;
        if (this.renderModel !== undefined) {
          this.renderModel.on('writeData', normalCallback);
        }
      } else {
        console.info(`${TAG}: creating AudioRenderer failed, error: ${err.message}`);
      }
    });
    ```
    
5.  AudioRender正常播放时，点击卡顿按钮，即可触发耗时回调，触发音频卡顿事件。
    
6.  每次音频卡顿触发后，可以在Log窗口看到对系统事件数据的处理日志。
    
    ```
    HiAppEvent onReceive: domain=OS
    HiAppEvent eventName=AUDIO_JANK_FRAME
    HiAppEvent eventInfo={"domain":"OS","name":"AUDIO_JANK_FRAME","eventType":1,"params":{"bundle_name":"com.samples.audio","bundle_version":"1.0.0","fault_type":"application","happen_time":3240511783,"max_frame_time":260,"process_name":"","time":1755587168818}}
    ```