@ray-js/api 1.7.81 → 1.7.82

package/@types/AVideoKit.d.ts

@@ -1,7 +1,7 @@
 /**
  * AVideoKit
  *
- * @version 1.0.6
+ * @version 1.0.12
  */
 declare namespace ty.avideo {
   /**
@@ -24,7 +24,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -51,9 +51,10 @@ declare namespace ty.avideo {
     /**
      * vad 级别
      * @since AVideoKit 1.0.0
-     * @defaultValue VadLevel.vzero
+     * @defaultValue 4
+     * @TEnum VadLevel
      */
-    level?: VadLevel
+    level?: 0 | 1 | 2 | 3 | 4
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
@@ -294,15 +295,30 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 状态码
+       * @since AVideoKit 1.0.0
+       */
       status_code: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 采样率
+       * @since AVideoKit 1.0.0
+       */
       sampleRate: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 声道数
+       * @since AVideoKit 1.0.0
+       */
       channelCount: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 数据包长度
+       * @since AVideoKit 1.0.0
+       */
       packetLength: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 解码后的数据
+       * @since AVideoKit 1.0.0
+       */
       packet_data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -346,7 +362,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -384,7 +400,10 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 音频流数据
+       * @since AVideoKit 1.0.0
+       */
       data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -428,7 +447,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -456,7 +475,10 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 音频流数据
+       * @since AVideoKit 1.0.0
+       */
       data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -496,7 +518,10 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 音频流数据
+       * @since AVideoKit 1.0.0
+       */
       data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -526,7 +551,10 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 音频流数据
+       * @since AVideoKit 1.0.0
+       */
       data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -566,15 +594,30 @@ declare namespace ty.avideo {
     complete?: () => void
     /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 状态码
+       * @since AVideoKit 1.0.0
+       */
       status_code: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 采样率
+       * @since AVideoKit 1.0.0
+       */
       sampleRate: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 声道数
+       * @since AVideoKit 1.0.0
+       */
       channelCount: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 数据包长度
+       * @since AVideoKit 1.0.0
+       */
       packetLength: number
-      /** @since AVideoKit 1.0.0 */
+      /**
+       * 解包后的数据
+       * @since AVideoKit 1.0.0
+       */
       packet_data: number[]
     }) => void
     /** 接口调用失败的回调函数 */
@@ -608,7 +651,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -640,7 +683,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -667,7 +710,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -694,7 +737,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -721,7 +764,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -895,9 +938,10 @@ declare namespace ty.avideo {
     /**
      * 压缩算法 ，目前只支持 IMA-ADPCM
      * @since AVideoKit 1.0.1
-     * @defaultValue CompressionAlgorithm.NO_Algorithm
+     * @defaultValue 0
+     * @TEnum CompressionAlgorithm
      */
-    compressType?: CompressionAlgorithm
+    compressType?: 0 | 1
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
@@ -939,9 +983,10 @@ declare namespace ty.avideo {
     /**
      * 编码格式
      * @since AVideoKit 1.0.0
-     * @defaultValue VideoCodecId.unknow
+     * @defaultValue -1
+     * @TEnum VideoCodecId
      */
-    codec?: VideoCodecId
+    codec?: -1 | 0 | 1 | 2
     /**
      * 宽
      * @since AVideoKit 1.0.0
@@ -960,7 +1005,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1002,9 +1047,10 @@ declare namespace ty.avideo {
     /**
      * 数据格式
      * @since AVideoKit 1.0.0
-     * @defaultValue PixelFormat.unknow
+     * @defaultValue -1
+     * @TEnum PixelFormat
      */
-    pixelFormat?: PixelFormat
+    pixelFormat?: -1 | 0 | 1 | 2
     /**
      * 时间戳
      * @since AVideoKit 1.0.0
@@ -1013,7 +1059,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1040,7 +1086,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1067,13 +1113,14 @@ declare namespace ty.avideo {
     /**
      * 编码格式
      * @since AVideoKit 1.0.0
-     * @defaultValue VideoCodecId.unknow
+     * @defaultValue -1
+     * @TEnum VideoCodecId
      */
-    codecId?: VideoCodecId
+    codecId?: -1 | 0 | 1 | 2
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1110,7 +1157,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1137,7 +1184,7 @@ declare namespace ty.avideo {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -1246,9 +1293,10 @@ declare namespace ty.avideo {
     /**
      * vad 级别
      * @since AVideoKit 1.0.0
-     * @defaultValue VadLevel.vzero
+     * @defaultValue 4
+     * @TEnum VadLevel
      */
-    level?: VadLevel
+    level?: 0 | 1 | 2 | 3 | 4
   }
 
   /** @since AVideoKit 1.0.0 */
@@ -1357,15 +1405,30 @@ declare namespace ty.avideo {
 
   /** @since AVideoKit 1.0.0 */
   export interface DecodeMp3FrameResponseModel {
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 状态码
+     * @since AVideoKit 1.0.0
+     */
     status_code: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 采样率
+     * @since AVideoKit 1.0.0
+     */
     sampleRate: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 声道数
+     * @since AVideoKit 1.0.0
+     */
     channelCount: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 数据包长度
+     * @since AVideoKit 1.0.0
+     */
     packetLength: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 解码后的数据
+     * @since AVideoKit 1.0.0
+     */
     packet_data: number[]
   }
 
@@ -1404,7 +1467,10 @@ declare namespace ty.avideo {
 
   /** @since AVideoKit 1.0.0 */
   export interface IntArrayResponseModel {
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 音频流数据
+     * @since AVideoKit 1.0.0
+     */
     data: number[]
   }
 
@@ -1457,15 +1523,30 @@ declare namespace ty.avideo {
 
   /** @since AVideoKit 1.0.0 */
   export interface UnpackOpusDataResponseModel {
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 状态码
+     * @since AVideoKit 1.0.0
+     */
     status_code: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 采样率
+     * @since AVideoKit 1.0.0
+     */
     sampleRate: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 声道数
+     * @since AVideoKit 1.0.0
+     */
     channelCount: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 数据包长度
+     * @since AVideoKit 1.0.0
+     */
     packetLength: number
-    /** @since AVideoKit 1.0.0 */
+    /**
+     * 解包后的数据
+     * @since AVideoKit 1.0.0
+     */
     packet_data: number[]
   }
 
@@ -1563,9 +1644,10 @@ declare namespace ty.avideo {
     /**
      * 压缩算法 ，目前只支持 IMA-ADPCM
      * @since AVideoKit 1.0.1
-     * @defaultValue CompressionAlgorithm.NO_Algorithm
+     * @defaultValue 0
+     * @TEnum CompressionAlgorithm
      */
-    compressType?: CompressionAlgorithm
+    compressType?: 0 | 1
   }
 
   /** @since AVideoKit 1.0.0 */
@@ -1600,9 +1682,10 @@ declare namespace ty.avideo {
     /**
      * 编码格式
      * @since AVideoKit 1.0.0
-     * @defaultValue VideoCodecId.unknow
+     * @defaultValue -1
+     * @TEnum VideoCodecId
      */
-    codec?: VideoCodecId
+    codec?: -1 | 0 | 1 | 2
     /**
      * 宽
      * @since AVideoKit 1.0.0
@@ -1667,9 +1750,10 @@ declare namespace ty.avideo {
     /**
      * 数据格式
      * @since AVideoKit 1.0.0
-     * @defaultValue PixelFormat.unknow
+     * @defaultValue -1
+     * @TEnum PixelFormat
      */
-    pixelFormat?: PixelFormat
+    pixelFormat?: -1 | 0 | 1 | 2
     /**
      * 时间戳
      * @since AVideoKit 1.0.0
@@ -1706,9 +1790,10 @@ declare namespace ty.avideo {
     /**
      * 编码格式
      * @since AVideoKit 1.0.0
-     * @defaultValue VideoCodecId.unknow
+     * @defaultValue -1
+     * @TEnum VideoCodecId
      */
-    codecId?: VideoCodecId
+    codecId?: -1 | 0 | 1 | 2
   }
 
   /** @since AVideoKit 1.0.0 */
@@ -1745,8 +1830,9 @@ declare namespace ty.avideo {
     /**
      * 数据格式
      * @since AVideoKit 1.0.0
-     * @defaultValue PixelFormat.unknow
+     * @defaultValue -1
+     * @TEnum PixelFormat
      */
-    pixelFormat?: PixelFormat
+    pixelFormat?: -1 | 0 | 1 | 2
   }
 }