@ray-js/api 1.7.81 → 1.7.82

package/@types/IPCKit.d.ts

@@ -1,58 +1,78 @@
 /**
  * IPCKit
  *
- * @version 7.7.10
+ * @version 7.9.0
  */
 declare namespace ty.ipc {
   /**
    * 生成云存储签名URL
    * @public
    * @since IPCKit 1.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.generateSignedUrl({
+   *   path: "xx",
+   *   expiration: "xx",
+   *   region: "xx",
+   *   token: "xx",
+   *   sk: "xx",
+   *   provider: "xx",
+   *   endpoint: "xx",
+   *   ak: "xx",
+   *   bucket: "xx",
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function generateSignedUrl(params: {
     /**
-     * file path
+     * 文件路径
      * @since IPCKit 1.2.0
      */
     path: string
     /**
-     * expiration
+     * 签名过期时间
      * @since IPCKit 1.2.0
      */
     expiration: string
     /**
-     * region
+     * 存储区域
      * @since IPCKit 1.2.0
      */
     region: string
     /**
-     * token
+     * 临时访问令牌
      * @since IPCKit 1.2.0
      */
     token: string
     /**
-     * sk
+     * 密钥（Secret Key）
      * @since IPCKit 1.2.0
      */
     sk: string
     /**
-     * provider
+     * 云存储服务商
      * @since IPCKit 1.2.0
      */
     provider: string
     /**
-     * endpoint
+     * 服务端点地址
      * @since IPCKit 1.2.0
      */
     endpoint: string
     /**
-     * ak
+     * 访问密钥（Access Key）
      * @since IPCKit 1.2.0
      */
     ak: string
     /**
-     * bucket
+     * 存储桶名称
      * @since IPCKit 1.2.0
      */
     bucket: string
@@ -61,7 +81,7 @@ declare namespace ty.ipc {
     /** 接口调用成功的回调函数 */
     success?: (params: {
       /**
-       * signed url
+       * 已签名的访问 URL
        * @since IPCKit 2.0.8
        */
       signedUrl: string
@@ -86,13 +106,24 @@ declare namespace ty.ipc {
    * 是否支持ai云存储设置页面
    * @public
    * @since IPCKit 6.8.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportAIDetectConfig({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportAIDetectConfig(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -110,16 +141,27 @@ declare namespace ty.ipc {
   }): void
 
   /**
-   * whether supports camera preset point config router
+   * 是否支持摄像头预置点配置路由
    * @public
    * @since IPCKit 7.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportCameraPresetPointConfig({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportCameraPresetPointConfig(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -140,6 +182,19 @@ declare namespace ty.ipc {
    * 是否开启 NS（音频降噪），需要在StartAudioRecord之前调用
    * @public
    * @since IPCKit 1.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableAudioNS({
+   *   deviceId: "xx",
+   *   enable: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableAudioNS(params: {
@@ -156,7 +211,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -177,6 +232,19 @@ declare namespace ty.ipc {
    * 是否开启 AGC（自动增益），需要在StartAudioRecord之前调用
    * @public
    * @since IPCKit 1.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableAudioAGC({
+   *   deviceId: "xx",
+   *   enable: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableAudioAGC(params: {
@@ -193,7 +261,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -214,6 +282,19 @@ declare namespace ty.ipc {
    * 是否开启 AEC（回音消除），需要在StartAudioRecord之前调用
    * @public
    * @since IPCKit 1.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableAudioAEC({
+   *   deviceId: "xx",
+   *   enable: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableAudioAEC(params: {
@@ -230,7 +311,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -251,6 +332,18 @@ declare namespace ty.ipc {
    * 获取摄像头配置
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.obtainCameraConfig({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function obtainCameraConfig(params: {
@@ -289,6 +382,19 @@ declare namespace ty.ipc {
    * 开始鸟类识别流程
    * @public
    * @since IPCKit 2.0.8
+   * @example Demo
+   * ```tsx
+   * ty.ipc.startIdentifyingBirds({
+   *   identifier: "xx",
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startIdentifyingBirds(params: {
@@ -332,6 +438,19 @@ declare namespace ty.ipc {
    * 取消鸟类识别流程
    * @public
    * @since IPCKit 2.0.8
+   * @example Demo
+   * ```tsx
+   * ty.ipc.cancelIdentifyingBirds({
+   *   identifier: "xx",
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function cancelIdentifyingBirds(params: {
@@ -348,7 +467,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -369,13 +488,24 @@ declare namespace ty.ipc {
    * 是否支持ai云存储
    * @public
    * @since IPCKit 2.0.8
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportAICloud({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportAICloud(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -396,13 +526,24 @@ declare namespace ty.ipc {
    * 是否支持喂鸟器
    * @public
    * @since IPCKit 2.0.8
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportBirdFeeder({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportBirdFeeder(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -424,13 +565,24 @@ declare namespace ty.ipc {
    * 目前有折叠屏不支持全屏的情况,iOS 默认 true
    * @public
    * @since IPCKit 5.14.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportFullScreen({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportFullScreen(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -451,13 +603,24 @@ declare namespace ty.ipc {
    * 是否支持精彩时刻
    * @public
    * @since IPCKit 6.3.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportWonderfulMoment({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportWonderfulMoment(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -478,13 +641,24 @@ declare namespace ty.ipc {
    * 是否支持新版消息中心
    * @public
    * @since IPCKit 7.2.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isShouldUseNMC({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isShouldUseNMC(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -505,13 +679,24 @@ declare namespace ty.ipc {
    * custom wallpaper whether supported on screen IPC
    * @public
    * @since IPCKit 6.5.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportScreenIPCCustomWallpaper({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportScreenIPCCustomWallpaper(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -532,6 +717,23 @@ declare namespace ty.ipc {
    * 下载云存储视频
    * @public
    * @since IPCKit 5.15.3
+   * @example Demo
+   * ```tsx
+   * ty.ipc.downloadCloudPlayBack({
+   *   deviceId: "xx",
+   *   url: "xx",
+   *   path: "xx",
+   *   prefix: 1,
+   *   videoSegments: [],
+   *   videoSegmentSize: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function downloadCloudPlayBack(params: {
@@ -546,7 +748,7 @@ declare namespace ty.ipc {
      */
     url: string
     /**
-     * 保存路径
+     * 下载成功后的保存路径
      * @since IPCKit 5.15.3
      */
     path: string
@@ -569,7 +771,10 @@ declare namespace ty.ipc {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since IPCKit 5.15.3 */
+      /**
+       * 视频保存路径
+       * @since IPCKit 5.15.3
+       */
       path: string
     }) => void
     /** 接口调用失败的回调函数 */
@@ -592,6 +797,18 @@ declare namespace ty.ipc {
    * 取消云存储下载
    * @public
    * @since IPCKit 5.15.3
+   * @example Demo
+   * ```tsx
+   * ty.ipc.cancelDownloadCloudPlayBack({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function cancelDownloadCloudPlayBack(params: {
@@ -603,7 +820,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -624,6 +841,21 @@ declare namespace ty.ipc {
    * 发送 dps
    * @public
    * @since IPCKit 6.0.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.publishDps({
+   *   deviceId: "xx",
+   *   dps: {},
+   *   mode: 1,
+   *   options: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function publishDps(params: {
@@ -674,6 +906,18 @@ declare namespace ty.ipc {
    * 是否支持设备上传日志
    * @public
    * @since IPCKit 6.0.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isDeviceSupportUploadLog({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isDeviceSupportUploadLog(params: {
@@ -706,6 +950,19 @@ declare namespace ty.ipc {
    * 上传设备日志
    * @public
    * @since IPCKit 6.0.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.uploadDeviceLog({
+   *   deviceId: "xx",
+   *   timeout: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function uploadDeviceLog(params: {
@@ -759,6 +1016,21 @@ declare namespace ty.ipc {
    * download file
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.downloadResourceToPhoneAlbum({
+   *   deviceId: "xx",
+   *   fileType: 0,
+   *   url: "xx",
+   *   secretKey: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function downloadResourceToPhoneAlbum(params: {
@@ -786,7 +1058,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -807,6 +1079,22 @@ declare namespace ty.ipc {
    * share resource by system
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.shareResourceBySystem({
+   *   deviceId: "xx",
+   *   fileType: 0,
+   *   url: "xx",
+   *   filePath: "xx",
+   *   secretKey: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function shareResourceBySystem(params: {
@@ -839,7 +1127,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -860,6 +1148,22 @@ declare namespace ty.ipc {
    * show identifying bird view
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.showIdentifyingBirdView({
+   *   deviceId: "xx",
+   *   identifier: "xx",
+   *   theme: 0,
+   *   scannerColor: "xx",
+   *   extData: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function showIdentifyingBirdView(params: {
@@ -874,7 +1178,7 @@ declare namespace ty.ipc {
      */
     identifier: string
     /**
-     * download url
+     * 主题类型，默认 0
      * @since IPCKit 6.1.2
      * @defaultValue 0
      */
@@ -892,7 +1196,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -913,13 +1217,24 @@ declare namespace ty.ipc {
    * dismiss identifying bird view
    * @public
    * @since IPCKit 6.8.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.dismissIdentifyingBirdView({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function dismissIdentifyingBirdView(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -940,6 +1255,20 @@ declare namespace ty.ipc {
    * snapshoot to sandbox
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.snapshootToSandbox({
+   *   deviceId: "xx",
+   *   filePath: "xx",
+   *   needSei: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function snapshootToSandbox(params: {
@@ -998,6 +1327,22 @@ declare namespace ty.ipc {
    * upload AI feature image
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.uploadAIFeatureImage({
+   *   deviceId: "xx",
+   *   taskId: "xx",
+   *   businessType: "xx",
+   *   contentType: "xx",
+   *   filePath: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function uploadAIFeatureImage(params: {
@@ -1017,7 +1362,7 @@ declare namespace ty.ipc {
      */
     businessType?: string
     /**
-     * content type, defaul is image/jpeg
+     * content type, default is image/jpeg
      * @since IPCKit 6.1.2
      */
     contentType?: string
@@ -1072,10 +1417,250 @@ declare namespace ty.ipc {
     }) => void
   }): void
 
+  /**
+   * set ai frame feature
+   * @public
+   * @since IPCKit 7.8.1
+   * @platform iOS Android
+   */
+  export function setAIFrameFeature(params: {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /**
+     * whether smart picture quality is enabled
+     * @since IPCKit 7.8.1
+     */
+    enabled: boolean
+    /**
+     * 场景（可选）：业务层定义 scope，inPreview（小程序，RN），inCloudData（云存储），inPlayback（SD卡），inMessage（IPC/公版消息中心，安全守护）
+     * @since IPCKit 7.8.1
+     */
+    scene?: string
+    /**
+     * ai frame feature config
+     * @since IPCKit 7.8.1
+     */
+    aiFrameFeature: AIFrameFeatureConfigModel
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * request ID
+       * @since IPCKit 7.8.1
+       */
+      requestId: string
+      /**
+       * preview absolute local path
+       * @since IPCKit 7.8.1
+       */
+      localPath: string
+      /**
+       * thingfile:// preview URI
+       * @since IPCKit 7.8.1
+       */
+      thingfileUri: string
+      /**
+       * ai frame feature config
+       * @since IPCKit 7.8.1
+       */
+      aiFrameFeature: AIFrameFeatureConfigModel
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * get ai frame feature
+   * @public
+   * @since IPCKit 7.8.1
+   * @platform iOS Android
+   */
+  export function getAIFrameFeature(params: {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * whether smart picture quality is enabled
+       * @since IPCKit 7.8.1
+       */
+      enabled: boolean
+      /**
+       * ai frame feature config
+       * @since IPCKit 7.8.1
+       */
+      aiFrameFeature: AIFrameFeatureCacheModel
+      /**
+       * SmartImageQualityPreviewFields 与入参一致时可带，便于小程序去重
+       * @since IPCKit 7.8.1
+       */
+      requestId?: string
+      /**
+       * SmartImageQualityPreviewFields App 沙箱内 增强后 预览图绝对路径（或团队约定的可读路径）
+       * @since IPCKit 7.8.1
+       */
+      localPath?: string
+      /**
+       * SmartImageQualityPreviewFields thingfile:// 形式预览图地址（可选；若 Uni 侧需 thingfile:// 形式，可复用现有拼接规则，参考 startDownloadMessageVideoForComposition）
+       * @since IPCKit 7.8.1
+       */
+      thingfileUri?: string
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 查询智能画质状态（四态 GUIDE / DISABLED / ENABLED / TRIAL）
+   * @public
+   * @since IPCKit 7.8.1
+   * @platform iOS Android
+   */
+  export function getSmartImageQualityState(params: {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /**
+     * 场景（可选）：'PREVIEW_PANEL' | 'SETTINGS' | 'MESSAGE'
+     * @since IPCKit 7.8.1
+     */
+    scene?: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 是否购买了云存储；true 且 SmartImageQualityState 缓存已创建时 trialRemainingSec 直接置 0（走试用结束逻辑）
+       * @since IPCKit 7.8.1
+       */
+      isPurchase: boolean
+      /**
+       * 三态：
+       * 0 = SmartImageQualityState 缓存未创建
+       * 1 = 开（aiFrameFeature 缓存已创建，且 ty.getAIFrameFeature 的 enabled 与对应 scope 均为开）
+       * 2 = 关（aiFrameFeature 缓存已创建，但 enabled 为关，或 enabled 开但 scope 关）
+       * @since IPCKit 7.8.1
+       */
+      buttonState: number
+      /**
+       * 试用剩余秒数。约定 TRIAL_MAX_SEC=300：
+       * 300       = 未试用
+       * 0 < x < 300 = 试用中
+       * 0         = 试用结束
+       * @since IPCKit 7.8.1
+       */
+      trialRemainingSec: number
+      /**
+       * 是否允许跳进设置页（虚拟设备等 false）
+       * @since IPCKit 7.8.1
+       */
+      canOpenSettings: boolean
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * set smart image quality trial finished
+   * @public
+   * @since IPCKit 7.8.1
+   * @platform iOS Android
+   */
+  export function setTrailFinish(params: {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 操作是否成功
+       * @since IPCKit 7.8.1
+       */
+      isSuccess: boolean
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * remove snapshoot from sandbox
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.removeSnapshootFromSandbox({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function removeSnapshootFromSandbox(params?: {
@@ -1087,7 +1672,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1108,11 +1693,26 @@ declare namespace ty.ipc {
    * 下载图片
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.downloadEncryptionImage({
+   *   url: "xx",
+   *   encryptKey: "xx",
+   *   deviceId: "xx",
+   *   fileName: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function downloadEncryptionImage(params: {
     /**
-     * 图片连接
+     * 图片链接
      * @since IPCKit 6.1.2
      */
     url: string
@@ -1127,7 +1727,7 @@ declare namespace ty.ipc {
      */
     deviceId: string
     /**
-     * fileName
+     * 保存的文件名
      * @since IPCKit 6.1.2
      */
     fileName: string
@@ -1135,7 +1735,10 @@ declare namespace ty.ipc {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since IPCKit 6.1.2 */
+      /**
+       * 文件路径
+       * @since IPCKit 6.1.2
+       */
       path: string
     }) => void
     /** 接口调用失败的回调函数 */
@@ -1158,6 +1761,19 @@ declare namespace ty.ipc {
    * 删除图片
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.deleteImages({
+   *   deviceId: "xx",
+   *   imagePath: [],
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function deleteImages(params: {
@@ -1174,7 +1790,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1195,6 +1811,18 @@ declare namespace ty.ipc {
    * 创建媒体设备，只能创建一次，如果要再次创建需要先销毁
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.createMediaDevice({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function createMediaDevice(params: {
@@ -1206,7 +1834,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1227,6 +1855,18 @@ declare namespace ty.ipc {
    * 销毁媒体设备
    * @public
    * @since IPCKit 6.3.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.destroyMediaDevice({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function destroyMediaDevice(params: {
@@ -1238,7 +1878,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1259,6 +1899,22 @@ declare namespace ty.ipc {
    * 视频下载支持旋转
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.startDownloadMessageVideo({
+   *   deviceId: "xx",
+   *   path: "xx",
+   *   encryptKey: "xx",
+   *   savePath: 1,
+   *   rotateMode: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startDownloadMessageVideo(params: {
@@ -1268,7 +1924,7 @@ declare namespace ty.ipc {
      */
     deviceId: string
     /**
-     * 路径
+     * 视频路径
      * @since IPCKit 6.1.0
      */
     path: string
@@ -1290,7 +1946,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1311,6 +1967,21 @@ declare namespace ty.ipc {
    * 视频下载，如果有多个视频文件，会合成为一个视频文件
    * @public
    * @since IPCKit 6.3.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.startDownloadMessageVideoForComposition({
+   *   deviceId: "xx",
+   *   fileInfo: "xx",
+   *   savePath: 1,
+   *   option: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startDownloadMessageVideoForComposition(params: {
@@ -1353,7 +2024,7 @@ declare namespace ty.ipc {
     /** 接口调用成功的回调函数 */
     success?: (params: {
       /**
-       * file path
+       * 云存下载完成后保存路径
        * @since IPCKit 6.3.1
        */
       path: string
@@ -1383,13 +2054,24 @@ declare namespace ty.ipc {
    * 取消视频下载
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.cancelDownloadMessageVideo({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function cancelDownloadMessageVideo(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1410,6 +2092,19 @@ declare namespace ty.ipc {
    * 获取视频码率
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getVideoBitrateKbps({
+   *   deviceId: "xx",
+   *   extendParam: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getVideoBitrateKbps(params: {
@@ -1453,6 +2148,19 @@ declare namespace ty.ipc {
    * 画中画：是否支持画中画：只有安卓在用
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportFloatWindow({
+   *   deviceId: "xx",
+   *   extendParam: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportFloatWindow(params: {
@@ -1496,6 +2204,19 @@ declare namespace ty.ipc {
    * 画中画：开启画中画
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.openFloatWindow({
+   *   deviceId: "xx",
+   *   extendParam: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function openFloatWindow(params: {
@@ -1512,7 +2233,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1533,6 +2254,19 @@ declare namespace ty.ipc {
    * IPC-APP缓存支持的对讲方式:是否支持对讲
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportedTalk({
+   *   deviceId: "xx",
+   *   extendParam: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportedTalk(params: {
@@ -1576,6 +2310,19 @@ declare namespace ty.ipc {
    * 设备支持的对讲模式
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getCurrentSupportedTalkMode({
+   *   deviceId: "xx",
+   *   extendParam: {},
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getCurrentSupportedTalkMode(params: {
@@ -1594,7 +2341,7 @@ declare namespace ty.ipc {
     /** 接口调用成功的回调函数 */
     success?: (params: {
       /**
-       * 设备支持的对讲模式。回掉方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
+       * 设备支持的对讲模式。回调方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
        * @since IPCKit 6.2.0
        */
       talkbackMode: number
@@ -1619,6 +2366,18 @@ declare namespace ty.ipc {
    * IPC TTT日志打点
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.ipcTTTOperatorLog({
+   *   ipcLogString: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function ipcTTTOperatorLog(params: {
@@ -1630,7 +2389,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1651,6 +2410,18 @@ declare namespace ty.ipc {
    * 唤醒门铃设备。门铃设备休眠时，需要在连接 p2p 通道之前调用
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.wakeUpDoorBell({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function wakeUpDoorBell(params: {
@@ -1662,7 +2433,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1683,6 +2454,19 @@ declare namespace ty.ipc {
    * 设置语音对讲变声音
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableVoiceEffect({
+   *   deviceId: "xx",
+   *   effectType: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableVoiceEffect(params: {
@@ -1699,7 +2483,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1720,6 +2504,18 @@ declare namespace ty.ipc {
    * 获取上次设置语音对讲变声音模式
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getLastAudioEffect({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getLastAudioEffect(params: {
@@ -1758,6 +2554,18 @@ declare namespace ty.ipc {
    * 是否已经连接
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isConnected({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isConnected(params: {
@@ -1796,6 +2604,18 @@ declare namespace ty.ipc {
    * 是否正在连接
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isConnecting({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isConnecting(params: {
@@ -1834,6 +2654,18 @@ declare namespace ty.ipc {
    * 请求连接
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.connect({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function connect(params: {
@@ -1845,7 +2677,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1866,6 +2698,18 @@ declare namespace ty.ipc {
    * 断开连接
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.disConnect({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function disConnect(params: {
@@ -1877,7 +2721,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1898,6 +2742,18 @@ declare namespace ty.ipc {
    * 是否断开连接
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isDisConnect({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isDisConnect(params: {
@@ -1936,6 +2792,18 @@ declare namespace ty.ipc {
    * 开启 debug log 输出给面板
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableDebugLog({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableDebugLog(params: {
@@ -1947,7 +2815,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1968,6 +2836,18 @@ declare namespace ty.ipc {
    * 关闭 debug log 输出给面板
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.disableDebugLog({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function disableDebugLog(params: {
@@ -1979,7 +2859,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2000,13 +2880,24 @@ declare namespace ty.ipc {
    * 上传 App 日志
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.uploadAppLog({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function uploadAppLog(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2027,13 +2918,24 @@ declare namespace ty.ipc {
    * whether supports playbackV2
    * @public
    * @since IPCKit 6.6.3
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportPlaybackV2({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportPlaybackV2(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2054,13 +2956,24 @@ declare namespace ty.ipc {
    * whether supports doorLock AOV
    * @public
    * @since IPCKit 6.7.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportDoorLockAOV({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportDoorLockAOV(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2081,13 +2994,24 @@ declare namespace ty.ipc {
    * whether supports detection setting
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.supportDetectionSetting({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function supportDetectionSetting(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2108,6 +3032,18 @@ declare namespace ty.ipc {
    * whether low power optimization is enabled
    * @public
    * @since IPCKit 7.6.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isLowPowerOptEnabled({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isLowPowerOptEnabled(params: {
@@ -2146,6 +3082,19 @@ declare namespace ty.ipc {
    * enable or disable low power optimization
    * @public
    * @since IPCKit 7.6.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.enableLowPowerOpt({
+   *   deviceId: "xx",
+   *   enable: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function enableLowPowerOpt(params: {
@@ -2162,7 +3111,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2183,6 +3132,17 @@ declare namespace ty.ipc {
    * whether should show mobile tips
    * @public
    * @since IPCKit 7.6.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.shouldShowMobileTips({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function shouldShowMobileTips(params?: {
@@ -2212,10 +3172,55 @@ declare namespace ty.ipc {
     }) => void
   }): void
 
+  /**
+   * 是否是低端机
+   * @public
+   * @since IPCKit 7.8.1
+   * @platform iOS Android
+   */
+  export function isLowPhone(params?: {
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 是否是低端机
+       * @since IPCKit 7.8.1
+       */
+      isLow: boolean
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * whether low power optimization is supported
    * @public
    * @since IPCKit 7.6.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportLowPowerOpt({
+   *   devId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportLowPowerOpt(params: {
@@ -2254,6 +3259,18 @@ declare namespace ty.ipc {
    * update mobile tips shown status
    * @public
    * @since IPCKit 7.6.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.updateMobileTipsShownStatus({
+   *   hasShown: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function updateMobileTipsShownStatus(params: {
@@ -2265,7 +3282,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2286,6 +3303,21 @@ declare namespace ty.ipc {
    * set camera smart frame
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.updateCameraSmartFrame({
+   *   devId: "xx",
+   *   frameType: 1,
+   *   value: "xx",
+   *   openState: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function updateCameraSmartFrame(params: {
@@ -2312,7 +3344,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2333,6 +3365,18 @@ declare namespace ty.ipc {
    * get camera smart frame
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getCameraSmartFrame({
+   *   devId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getCameraSmartFrame(params: {
@@ -2376,6 +3420,21 @@ declare namespace ty.ipc {
    * set camera cross line frame
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.updateCameraCrosslineFrame({
+   *   devId: "xx",
+   *   lineType: 1,
+   *   value: "xx",
+   *   openState: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function updateCameraCrosslineFrame(params: {
@@ -2402,7 +3461,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2423,6 +3482,18 @@ declare namespace ty.ipc {
    * get camera cross line frame
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getCameraCrosslineFrame({
+   *   devId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getCameraCrosslineFrame(params: {
@@ -2466,6 +3537,19 @@ declare namespace ty.ipc {
    * set camera talk mode
    * @public
    * @since IPCKit 6.10.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.updateCameraAudioMode({
+   *   devId: "xx",
+   *   mode: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function updateCameraAudioMode(params: {
@@ -2482,7 +3566,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2503,6 +3587,18 @@ declare namespace ty.ipc {
    * get ttt abilityKeyList
    * @public
    * @since IPCKit 7.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.getTTTAbilityKeyList({
+   *   key: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function getTTTAbilityKeyList(params: {
@@ -2538,9 +3634,21 @@ declare namespace ty.ipc {
   }): void
 
   /**
-   * allow show device persionssion alert
+   * allow show device permission alert
    * @public
    * @since IPCKit 7.5.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.allowShowDevicePermissionAlert({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function allowShowDevicePermissionAlert(params: {
@@ -2552,7 +3660,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2573,6 +3681,18 @@ declare namespace ty.ipc {
    * 查询业务能力
    * @public
    * @since IPCKit 7.5.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.queryBizSkills({
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function queryBizSkills(params: {
@@ -2616,6 +3736,19 @@ declare namespace ty.ipc {
    * 下发业务动作控制指令
    * @public
    * @since IPCKit 7.5.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.startBizAction({
+   *   deviceId: "xx",
+   *   action: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startBizAction(params: {
@@ -2669,6 +3802,19 @@ declare namespace ty.ipc {
    * 取消业务动作控制指令
    * @public
    * @since IPCKit 7.5.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.cancelBizAction({
+   *   deviceId: "xx",
+   *   cmdId: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function cancelBizAction(params: {
@@ -2722,13 +3868,66 @@ declare namespace ty.ipc {
    * 智能推送流程结束，进入下一步通知
    * @public
    * @since IPCKit 7.7.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.goNextStepWhenSmartPushProcessEnd({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function goNextStepWhenSmartPushProcessEnd(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 更新报告已读状态
+   * @public
+   * @since IPCKit 7.8.0
+   * @platform iOS Android
+   */
+  export function protectSummaryDidRead(params: {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.0
+     */
+    devId: string
+    /**
+     * eventTime 时间
+     * @since IPCKit 7.8.0
+     */
+    eventTime: string
+    /**
+     * defaultDesc 描述
+     * @since IPCKit 7.8.0
+     */
+    defaultDesc: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2753,6 +3952,18 @@ declare namespace ty.ipc {
    * 参数由app与面板共同约定
    * @public
    * @since IPCKit 1.0.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.gotoCameraSettingsRouter({
+   *   url: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function gotoCameraSettingsRouter(params: {
@@ -2765,7 +3976,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2787,6 +3998,18 @@ declare namespace ty.ipc {
    * 参数由app与面板共同约定
    * @public
    * @since IPCKit 1.0.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.couldChangeTalkbackMode({
+   *   devId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function couldChangeTalkbackMode(params: {
@@ -2798,7 +4021,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2819,6 +4042,19 @@ declare namespace ty.ipc {
    * 门铃呼叫参数设置
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.doorbellCallConfig({
+   *   ignoreWhenCalling: true,
+   *   doorbellRingTimeOut: 25,
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function doorbellCallConfig(params?: {
@@ -2837,7 +4073,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2858,6 +4094,18 @@ declare namespace ty.ipc {
    * 接听门铃呼叫
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.acceptDoorbellCall({
+   *   messageId: "xx",
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function acceptDoorbellCall(params: {
@@ -2869,7 +4117,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2890,6 +4138,18 @@ declare namespace ty.ipc {
    * 拒绝门铃呼叫
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.refuseDoorbellCall({
+   *   messageId: "xx",
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function refuseDoorbellCall(params: {
@@ -2901,7 +4161,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2922,6 +4182,18 @@ declare namespace ty.ipc {
    * 挂断门铃呼叫
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.hangupDoorbellCall({
+   *   messageId: "xx",
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function hangupDoorbellCall(params: {
@@ -2933,7 +4205,7 @@ declare namespace ty.ipc {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2954,13 +4226,24 @@ declare namespace ty.ipc {
    * 是否自定义默认语音配置
    * @public
    * @since IPCKit 5.15.1
+   * @example Demo
+   * ```tsx
+   * ty.ipc.isSupportedCustomDefaultAudioConfig({
+   *   success: (res) => {
+   *     console.log(res);
+   *   },
+   *   fail: (err) => {
+   *     console.log(err);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isSupportedCustomDefaultAudioConfig(params?: {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -2980,7 +4263,13 @@ declare namespace ty.ipc {
   /**
    * 创建视图完成回调
    * @public
-   * @since IPCKit 6.3.1
+   * @since IPCKit 6.3.11
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onCreateViewSuccess(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onCreateViewSuccess(
@@ -2990,7 +4279,13 @@ declare namespace ty.ipc {
   /**
    * 创建视图完成回调
    * @public
-   * @since IPCKit 6.3.1
+   * @since IPCKit 6.3.11
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onCreateViewSuccess(listener)
+   * ty.ipc.offCreateViewSuccess(listener)
+   * ```
    * @platform iOS Android
    */
   export function offCreateViewSuccess(
@@ -3001,6 +4296,12 @@ declare namespace ty.ipc {
    * 视频播放信息回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onPlayMessageVideoInfo(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onPlayMessageVideoInfo(
@@ -3011,6 +4312,12 @@ declare namespace ty.ipc {
    * 视频播放信息回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onPlayMessageVideoInfo(listener)
+   * ty.ipc.offPlayMessageVideoInfo(listener)
+   * ```
    * @platform iOS Android
    */
   export function offPlayMessageVideoInfo(
@@ -3021,6 +4328,12 @@ declare namespace ty.ipc {
    * 音频播放信息回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onPlayMessageAudioInfo(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onPlayMessageAudioInfo(
@@ -3031,6 +4344,12 @@ declare namespace ty.ipc {
    * 音频播放信息回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onPlayMessageAudioInfo(listener)
+   * ty.ipc.offPlayMessageAudioInfo(listener)
+   * ```
    * @platform iOS Android
    */
   export function offPlayMessageAudioInfo(
@@ -3041,6 +4360,12 @@ declare namespace ty.ipc {
    * 播放完成回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onPlayMessageVideoFinish(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onPlayMessageVideoFinish(
@@ -3051,6 +4376,12 @@ declare namespace ty.ipc {
    * 播放完成回调
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onPlayMessageVideoFinish(listener)
+   * ty.ipc.offPlayMessageVideoFinish(listener)
+   * ```
    * @platform iOS Android
    */
   export function offPlayMessageVideoFinish(
@@ -3061,6 +4392,12 @@ declare namespace ty.ipc {
    * 播放完成失败回调
    * @public
    * @since IPCKit 6.10.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onPlayMessageVideoError(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onPlayMessageVideoError(
@@ -3071,6 +4408,12 @@ declare namespace ty.ipc {
    * 播放完成失败回调
    * @public
    * @since IPCKit 6.10.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onPlayMessageVideoError(listener)
+   * ty.ipc.offPlayMessageVideoError(listener)
+   * ```
    * @platform iOS Android
    */
   export function offPlayMessageVideoError(
@@ -3081,6 +4424,12 @@ declare namespace ty.ipc {
    * 下载进度事件
    * @public
    * @since IPCKit 5.16.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onCloudPlayBackDownloadProgress(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onCloudPlayBackDownloadProgress(
@@ -3091,6 +4440,12 @@ declare namespace ty.ipc {
    * 下载进度事件
    * @public
    * @since IPCKit 5.16.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onCloudPlayBackDownloadProgress(listener)
+   * ty.ipc.offCloudPlayBackDownloadProgress(listener)
+   * ```
    * @platform iOS Android
    */
   export function offCloudPlayBackDownloadProgress(
@@ -3101,6 +4456,12 @@ declare namespace ty.ipc {
    * identifying bird view action trigger
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onIdentifyingBirdViewActionTrigger(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onIdentifyingBirdViewActionTrigger(
@@ -3111,6 +4472,12 @@ declare namespace ty.ipc {
    * identifying bird view action trigger
    * @public
    * @since IPCKit 6.1.2
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onIdentifyingBirdViewActionTrigger(listener)
+   * ty.ipc.offIdentifyingBirdViewActionTrigger(listener)
+   * ```
    * @platform iOS Android
    */
   export function offIdentifyingBirdViewActionTrigger(
@@ -3121,6 +4488,12 @@ declare namespace ty.ipc {
    * 视频下载结束
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDownloadMessageVideoFinished(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDownloadMessageVideoFinished(
@@ -3131,6 +4504,12 @@ declare namespace ty.ipc {
    * 视频下载结束
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDownloadMessageVideoFinished(listener)
+   * ty.ipc.offDownloadMessageVideoFinished(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDownloadMessageVideoFinished(
@@ -3141,6 +4520,12 @@ declare namespace ty.ipc {
    * 视频下载进度
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDownloadMessageVideoProgress(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDownloadMessageVideoProgress(
@@ -3151,6 +4536,12 @@ declare namespace ty.ipc {
    * 视频下载进度
    * @public
    * @since IPCKit 6.1.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDownloadMessageVideoProgress(listener)
+   * ty.ipc.offDownloadMessageVideoProgress(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDownloadMessageVideoProgress(
@@ -3161,6 +4552,12 @@ declare namespace ty.ipc {
    * 面板调试日志事件
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDebugLogHit(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDebugLogHit(
@@ -3171,6 +4568,12 @@ declare namespace ty.ipc {
    * 面板调试日志事件
    * @public
    * @since IPCKit 6.2.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDebugLogHit(listener)
+   * ty.ipc.offDebugLogHit(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDebugLogHit(
@@ -3181,6 +4584,12 @@ declare namespace ty.ipc {
    * 业务动作完成通知
    * @public
    * @since IPCKit 7.5.2
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onBizActionFinished(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onBizActionFinished(
@@ -3191,6 +4600,12 @@ declare namespace ty.ipc {
    * 业务动作完成通知
    * @public
    * @since IPCKit 7.5.2
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onBizActionFinished(listener)
+   * ty.ipc.offBizActionFinished(listener)
+   * ```
    * @platform iOS Android
    */
   export function offBizActionFinished(
@@ -3201,6 +4616,12 @@ declare namespace ty.ipc {
    * 门铃呼叫挂断事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDoorBellCallHangUp(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDoorBellCallHangUp(
@@ -3211,6 +4632,12 @@ declare namespace ty.ipc {
    * 门铃呼叫挂断事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDoorBellCallHangUp(listener)
+   * ty.ipc.offDoorBellCallHangUp(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDoorBellCallHangUp(
@@ -3221,6 +4648,12 @@ declare namespace ty.ipc {
    * 其他终端挂断门铃呼叫事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDoorBellCallHangUpByOther(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDoorBellCallHangUpByOther(
@@ -3231,6 +4664,12 @@ declare namespace ty.ipc {
    * 其他终端挂断门铃呼叫事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDoorBellCallHangUpByOther(listener)
+   * ty.ipc.offDoorBellCallHangUpByOther(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDoorBellCallHangUpByOther(
@@ -3241,6 +4680,12 @@ declare namespace ty.ipc {
    * 取消门铃呼叫事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * ty.ipc.onDoorBellCallCancel(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onDoorBellCallCancel(
@@ -3251,75 +4696,87 @@ declare namespace ty.ipc {
    * 取消门铃呼叫事件
    * @public
    * @since IPCKit 1.3.0
+   * @example Demo
+   * ```tsx
+   * const listener = function (res) { console.log(res) }
+   * ty.ipc.onDoorBellCallCancel(listener)
+   * ty.ipc.offDoorBellCallCancel(listener)
+   * ```
    * @platform iOS Android
    */
   export function offDoorBellCallCancel(
     listener: (params: DoorbellCallEventResponse) => void
   ): void
 
-  /** @since IPCKit 1.2.0 */
+  /**
+   * 云存储签名请求参数
+   * @since IPCKit 1.2.0
+   */
   export interface CloudStorageSignatureParams {
     /**
-     * file path
+     * 文件路径
      * @since IPCKit 1.2.0
      */
     path: string
     /**
-     * expiration
+     * 签名过期时间
      * @since IPCKit 1.2.0
      */
     expiration: string
     /**
-     * region
+     * 存储区域
      * @since IPCKit 1.2.0
      */
     region: string
     /**
-     * token
+     * 临时访问令牌
      * @since IPCKit 1.2.0
      */
     token: string
     /**
-     * sk
+     * 密钥（Secret Key）
      * @since IPCKit 1.2.0
      */
     sk: string
     /**
-     * provider
+     * 云存储服务商
      * @since IPCKit 1.2.0
      */
     provider: string
     /**
-     * endpoint
+     * 服务端点地址
      * @since IPCKit 1.2.0
      */
     endpoint: string
     /**
-     * ak
+     * 访问密钥（Access Key）
      * @since IPCKit 1.2.0
      */
     ak: string
     /**
-     * bucket
+     * 存储桶名称
      * @since IPCKit 1.2.0
      */
     bucket: string
   }
 
-  /** @since IPCKit 1.2.0 */
+  /**
+   * 云存储签名响应结果
+   * @since IPCKit 1.2.0
+   */
   export interface CloudStorageSignatureResponse {
     /**
-     * signed url
+     * 已签名的访问 URL
      * @since IPCKit 1.2.0
      */
     signedUrl: string
   }
 
-  /** @since IPCKit 6.3.1 */
+  /** @since IPCKit 6.3.11 */
   export interface MessageCreateViewModel {
     /**
      * 创建成功
-     * @since IPCKit 6.3.1
+     * @since IPCKit 6.3.11
      */
     success: boolean
   }
@@ -3545,7 +5002,7 @@ declare namespace ty.ipc {
      */
     url: string
     /**
-     * 保存路径
+     * 下载成功后的保存路径
      * @since IPCKit 5.15.3
      */
     path: string
@@ -3568,7 +5025,10 @@ declare namespace ty.ipc {
 
   /** @since IPCKit 5.16.0 */
   export interface CloudPlayBackDownloadSuccessModel {
-    /** @since IPCKit 5.16.0 */
+    /**
+     * 视频保存路径
+     * @since IPCKit 5.16.0
+     */
     path: string
   }
 
@@ -3718,7 +5178,7 @@ declare namespace ty.ipc {
      */
     identifier: string
     /**
-     * download url
+     * 主题类型，默认 0
      * @since IPCKit 6.1.2
      * @defaultValue 0
      */
@@ -3806,7 +5266,7 @@ declare namespace ty.ipc {
      */
     businessType?: string
     /**
-     * content type, defaul is image/jpeg
+     * content type, default is image/jpeg
      * @since IPCKit 6.1.2
      */
     contentType?: string
@@ -3846,6 +5306,235 @@ declare namespace ty.ipc {
     url: string
   }
 
+  /** @since IPCKit 7.8.1 */
+  export interface AIFrameFeatureScopeModel {
+    /**
+     * whether ai frame feature takes effect in preview
+     * @since IPCKit 7.8.1
+     */
+    inPreview: boolean
+    /**
+     * whether ai frame feature takes effect in message
+     * @since IPCKit 7.8.1
+     */
+    inMessage: boolean
+    /**
+     * whether ai frame feature takes effect in playback
+     * @since IPCKit 7.8.1
+     */
+    inPlayback: boolean
+    /**
+     * whether ai frame feature takes effect in cloud data
+     * @since IPCKit 7.8.1
+     */
+    inCloudData: boolean
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface AIFrameFeatureSwitchModel {
+    /**
+     * super resolution model status, 0: off, 1: on
+     * @since IPCKit 7.8.1
+     */
+    srModelStatus: number
+    /**
+     * light enhancement model status, 0: off, 1: on
+     * @since IPCKit 7.8.1
+     */
+    lightModelStatus: number
+    /**
+     * filter status, 0: original, 1: vibrant, 2: fresh, 3: texture
+     * @since IPCKit 7.8.1
+     */
+    filterStatus: number
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface AIFrameFeatureConfigModel {
+    /**
+     * take effect scope config
+     * @since IPCKit 7.8.1
+     */
+    scope: AIFrameFeatureScopeModel
+    /**
+     * ai feature switch config
+     * @since IPCKit 7.8.1
+     */
+    feature: AIFrameFeatureSwitchModel
+    /**
+     * whether export processed images/videos
+     * @since IPCKit 7.8.1
+     */
+    exportEnabled: boolean
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface SetAIFrameFeatureParams {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /**
+     * whether smart picture quality is enabled
+     * @since IPCKit 7.8.1
+     */
+    enabled: boolean
+    /**
+     * 场景（可选）：业务层定义 scope，inPreview（小程序，RN），inCloudData（云存储），inPlayback（SD卡），inMessage（IPC/公版消息中心，安全守护）
+     * @since IPCKit 7.8.1
+     */
+    scene?: string
+    /**
+     * ai frame feature config
+     * @since IPCKit 7.8.1
+     */
+    aiFrameFeature: AIFrameFeatureConfigModel
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface SetAIFrameFeatureResult {
+    /**
+     * request ID
+     * @since IPCKit 7.8.1
+     */
+    requestId: string
+    /**
+     * preview absolute local path
+     * @since IPCKit 7.8.1
+     */
+    localPath: string
+    /**
+     * thingfile:// preview URI
+     * @since IPCKit 7.8.1
+     */
+    thingfileUri: string
+    /**
+     * ai frame feature config
+     * @since IPCKit 7.8.1
+     */
+    aiFrameFeature: AIFrameFeatureConfigModel
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface GetAIFrameFeatureParams {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface AIFrameFeatureCacheModel {
+    /**
+     * take effect scope config
+     * @since IPCKit 7.8.1
+     */
+    scope?: AIFrameFeatureScopeModel
+    /**
+     * ai feature switch config
+     * @since IPCKit 7.8.1
+     */
+    feature?: AIFrameFeatureSwitchModel
+    /**
+     * whether export processed images/videos
+     * @since IPCKit 7.8.1
+     */
+    exportEnabled?: boolean
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface GetAIFrameFeatureResult {
+    /**
+     * whether smart picture quality is enabled
+     * @since IPCKit 7.8.1
+     */
+    enabled: boolean
+    /**
+     * ai frame feature config
+     * @since IPCKit 7.8.1
+     */
+    aiFrameFeature: AIFrameFeatureCacheModel
+    /**
+     * SmartImageQualityPreviewFields 与入参一致时可带，便于小程序去重
+     * @since IPCKit 7.8.1
+     */
+    requestId?: string
+    /**
+     * SmartImageQualityPreviewFields App 沙箱内 增强后 预览图绝对路径（或团队约定的可读路径）
+     * @since IPCKit 7.8.1
+     */
+    localPath?: string
+    /**
+     * SmartImageQualityPreviewFields thingfile:// 形式预览图地址（可选；若 Uni 侧需 thingfile:// 形式，可复用现有拼接规则，参考 startDownloadMessageVideoForComposition）
+     * @since IPCKit 7.8.1
+     */
+    thingfileUri?: string
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface GetSmartImageQualityStateParams {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+    /**
+     * 场景（可选）：'PREVIEW_PANEL' | 'SETTINGS' | 'MESSAGE'
+     * @since IPCKit 7.8.1
+     */
+    scene?: string
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface SmartImageQualityState {
+    /**
+     * 是否购买了云存储；true 且 SmartImageQualityState 缓存已创建时 trialRemainingSec 直接置 0（走试用结束逻辑）
+     * @since IPCKit 7.8.1
+     */
+    isPurchase: boolean
+    /**
+     * 三态：
+     * 0 = SmartImageQualityState 缓存未创建
+     * 1 = 开（aiFrameFeature 缓存已创建，且 ty.getAIFrameFeature 的 enabled 与对应 scope 均为开）
+     * 2 = 关（aiFrameFeature 缓存已创建，但 enabled 为关，或 enabled 开但 scope 关）
+     * @since IPCKit 7.8.1
+     */
+    buttonState: number
+    /**
+     * 试用剩余秒数。约定 TRIAL_MAX_SEC=300：
+     * 300       = 未试用
+     * 0 < x < 300 = 试用中
+     * 0         = 试用结束
+     * @since IPCKit 7.8.1
+     */
+    trialRemainingSec: number
+    /**
+     * 是否允许跳进设置页（虚拟设备等 false）
+     * @since IPCKit 7.8.1
+     */
+    canOpenSettings: boolean
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface SetTrailFinishParams {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.1
+     */
+    devId: string
+  }
+
+  /** @since IPCKit 7.8.1 */
+  export interface SetTrailFinishResult {
+    /**
+     * 操作是否成功
+     * @since IPCKit 7.8.1
+     */
+    isSuccess: boolean
+  }
+
   /** @since IPCKit 6.1.2 */
   export interface RemoveSnapshotParams {
     /**
@@ -3858,7 +5547,7 @@ declare namespace ty.ipc {
   /** @since IPCKit 6.1.2 */
   export interface DownloadEncryptionImageParams {
     /**
-     * 图片连接
+     * 图片链接
      * @since IPCKit 6.1.2
      */
     url: string
@@ -3873,7 +5562,7 @@ declare namespace ty.ipc {
      */
     deviceId: string
     /**
-     * fileName
+     * 保存的文件名
      * @since IPCKit 6.1.2
      */
     fileName: string
@@ -3881,7 +5570,10 @@ declare namespace ty.ipc {
 
   /** @since IPCKit 6.1.2 */
   export interface StringCallbackClass {
-    /** @since IPCKit 6.1.2 */
+    /**
+     * 文件路径
+     * @since IPCKit 6.1.2
+     */
     path: string
   }
 
@@ -3916,7 +5608,7 @@ declare namespace ty.ipc {
      */
     deviceId: string
     /**
-     * 路径
+     * 视频路径
      * @since IPCKit 6.1.0
      */
     path: string
@@ -4003,7 +5695,7 @@ declare namespace ty.ipc {
   /** @since IPCKit 6.3.1 */
   export interface DownloadVideoSuccessModel {
     /**
-     * file path
+     * 云存下载完成后保存路径
      * @since IPCKit 6.3.1
      */
     path: string
@@ -4132,7 +5824,7 @@ declare namespace ty.ipc {
   /** @since IPCKit 6.2.0 */
   export interface CurrentSupportedTalkModel {
     /**
-     * 设备支持的对讲模式。回掉方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
+     * 设备支持的对讲模式。回调方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
      * @since IPCKit 6.2.0
      */
     talkbackMode: number
@@ -4274,6 +5966,15 @@ declare namespace ty.ipc {
     shown: boolean
   }
 
+  /** @since IPCKit 7.8.1 */
+  export interface IsLowPhoneResult {
+    /**
+     * 是否是低端机
+     * @since IPCKit 7.8.1
+     */
+    isLow: boolean
+  }
+
   /** @since IPCKit 7.6.0 */
   export interface IsSupportLowPowerOptParams {
     /**
@@ -4526,6 +6227,25 @@ declare namespace ty.ipc {
     errorCode: number
   }
 
+  /** @since IPCKit 7.8.0 */
+  export interface ProtectSummaryDidReadParams {
+    /**
+     * devId 设备id
+     * @since IPCKit 7.8.0
+     */
+    devId: string
+    /**
+     * eventTime 时间
+     * @since IPCKit 7.8.0
+     */
+    eventTime: string
+    /**
+     * defaultDesc 描述
+     * @since IPCKit 7.8.0
+     */
+    defaultDesc: string
+  }
+
   /** @since IPCKit 6.0.0 */
   export interface DeviceDpUpdateBody {
     /**
@@ -4544,7 +6264,10 @@ declare namespace ty.ipc {
     deviceId: string
   }
 
-  /** @since IPCKit 1.0.0 */
+  /**
+   * 路由跳转参数
+   * @since IPCKit 1.0.0
+   */
   export interface RouterParamsBean {
     /**
      * Router url: "thingSmart://" + 路由名 + "?" + 参数名1 + "=" + 参数1 + "&" + 参数名2 + "=" +参数2 +...
@@ -4554,7 +6277,10 @@ declare namespace ty.ipc {
     url: string
   }
 
-  /** @since IPCKit 1.0.0 */
+  /**
+   * 设备参数
+   * @since IPCKit 1.0.0
+   */
   export interface DeviceParamsBean {
     /**
      * 设备ID
@@ -4563,7 +6289,10 @@ declare namespace ty.ipc {
     devId: string
   }
 
-  /** @since IPCKit 1.3.0 */
+  /**
+   * 门铃呼叫配置参数
+   * @since IPCKit 1.3.0
+   */
   export interface DoorbellConfigParams {
     /**
      * 是否忽略门铃呼叫
@@ -4579,7 +6308,10 @@ declare namespace ty.ipc {
     doorbellRingTimeOut?: number
   }
 
-  /** @since IPCKit 1.3.0 */
+  /**
+   * 门铃呼叫操作参数
+   * @since IPCKit 1.3.0
+   */
   export interface DoorbellCallParams {
     /**
      * 门铃呼叫消息id
@@ -4588,7 +6320,10 @@ declare namespace ty.ipc {
     messageId: string
   }
 
-  /** @since IPCKit 1.3.0 */
+  /**
+   * 门铃呼叫事件响应
+   * @since IPCKit 1.3.0
+   */
   export interface DoorbellCallEventResponse {
     /**
      * 返回结果