@xmaxai/web-sdk 1.0.0 → 1.0.1

package/dist/{VideoContentMode-BXkqM4XG.d.cts → VideoContentMode-BM97_H8V.d.cts}

@@ -2,34 +2,74 @@
  * 实时视频的编码策略偏好。
  */
 declare enum RealtimeVideoEncoderPreference {
-    /** 优先保障帧率（弱网降分辨率）。 */
+    /**
+     * 优先保障帧率（弱网降分辨率）。
+     */
     maintainFramerate = "maintainFramerate",
-    /** 优先保障分辨率（弱网降帧率）。 */
+    /**
+     * 优先保障分辨率（弱网降帧率）。
+     */
     maintainQuality = "maintainQuality"
 }
 interface RealtimeVideoFormatInit {
-    /** 视频宽度，单位为像素。 */
+    /**
+     * 视频宽度，单位为像素。
+     */
     width: number;
-    /** 视频高度，单位为像素。 */
+    /**
+     * 视频高度，单位为像素。
+     */
     height: number;
-    /** 视频帧率，必须大于 0。 */
+    /**
+     * 视频帧率，必须大于 0。
+     */
     fps: number;
-    /** 最低上传码率，单位为 kbps；缺省使用 SDK 默认值，0 表示不设最低码率。 */
+    /**
+     * 最低上传码率，单位为 kbps；缺省使用 SDK 默认值，0 表示不设最低码率。
+     */
     minimumBitrate?: number;
-    /** 最高上传码率，单位为 kbps；缺省使用 SDK 默认值，指定时必须大于 0。 */
+    /**
+     * 最高上传码率，单位为 kbps；缺省使用 SDK 默认值，指定时必须大于 0。
+     */
     maximumBitrate?: number;
-    /** 上传编码策略偏好，默认优先保障帧率。 */
+    /**
+     * 上传编码策略偏好，默认优先保障帧率。
+     */
     encoderPreference?: RealtimeVideoEncoderPreference;
 }
 /**
  * 实时视频的尺寸、帧率和上传编码配置。
  */
 declare class RealtimeVideoFormat {
+    /**
+     * 视频规格
+     */
+    /**
+     * 视频宽度，单位为像素。
+     */
     readonly width: number;
+    /**
+     * 视频高度，单位为像素。
+     */
     readonly height: number;
+    /**
+     * 视频帧率，单位为 fps。
+     */
     readonly fps: number;
+    /**
+     * 上传编码配置
+     */
+    /**
+     * 最低上传码率，单位为 kbps；未指定时由 SDK 计算，0 表示不设最低码率。
+     */
     readonly minimumBitrate?: number;
+    /**
+     * 最高上传码率，单位为 kbps；未指定时由 SDK 计算。
+     */
     readonly maximumBitrate?: number;
+    /**
+     * 弱网下优先保障帧率或分辨率的编码策略。
+     */
     readonly encoderPreference: RealtimeVideoEncoderPreference;
     /**
      * 创建实时视频格式。
@@ -47,7 +87,9 @@ declare class RealtimeVideoFormat {
      * @throws 尺寸、帧率或码率配置无效时抛出错误。
      */
     validate(): void;
-    /** 调整尺寸，保留帧率和上传编码配置。 */
+    /**
+     * 调整尺寸，保留帧率和上传编码配置。
+     */
     resized(width: number, height: number): RealtimeVideoFormat;
 }
 
@@ -58,18 +100,28 @@ declare class RealtimeVideoFormat {
  * 摄像头，back 会回退到可用设备。
  */
 declare enum CameraPosition {
-    /** 前置摄像头（面向用户）。 */
+    /**
+     * 前置摄像头（面向用户）。
+     */
     front = "front",
-    /** 后置摄像头（面向环境）。 */
+    /**
+     * 后置摄像头（面向环境）。
+     */
     back = "back"
 }
 
 interface RealtimeVideoTrackInit {
-    /** 视频轨道标识。 */
+    /**
+     * 视频轨道标识。
+     */
     id: string;
-    /** 轨道当前使用的视频格式。 */
+    /**
+     * 轨道当前使用的视频格式。
+     */
     videoFormat?: RealtimeVideoFormat;
-    /** 本地相机轨道的摄像头位置。 */
+    /**
+     * 本地相机轨道的摄像头位置。
+     */
     position?: CameraPosition;
 }
 /**
@@ -79,9 +131,20 @@ interface RealtimeVideoTrackInit {
  * 渲染层通过它把画面绑定到 `<video>` 元素。
  */
 declare class RealtimeVideoTrack {
-    /** 视频轨道标识。 */
+    /**
+     * 轨道信息
+     */
+    /**
+     * 视频轨道标识。
+     */
     readonly id: string;
+    /**
+     * 动态元数据
+     */
     private metadata;
+    /**
+     * 平台资源
+     */
     /**
      * SDK 内部：轨道对应的 Web 媒体轨。
      * 本地轨道在采集启动后可用；远端轨道在订阅成功后可用。
@@ -95,13 +158,21 @@ declare class RealtimeVideoTrack {
      * @param init.position 本地相机轨道的初始摄像头位置。
      */
     constructor(init: RealtimeVideoTrackInit);
-    /** 当前视频轨道使用的视频格式。 */
+    /**
+     * 当前视频轨道使用的视频格式。
+     */
     get videoFormat(): RealtimeVideoFormat | undefined;
-    /** 本地相机轨道当前使用的摄像头位置。 */
+    /**
+     * 本地相机轨道当前使用的摄像头位置。
+     */
     get position(): CameraPosition | undefined;
-    /** 更新轨道视频格式。 @internal */
+    /**
+     * 更新轨道视频格式。 @internal
+     */
     updateVideoFormat(videoFormat: RealtimeVideoFormat): void;
-    /** 更新轨道摄像头位置。 @internal */
+    /**
+     * 更新轨道摄像头位置。 @internal
+     */
     updatePosition(position: CameraPosition): void;
 }
 
@@ -109,9 +180,13 @@ declare class RealtimeVideoTrack {
  * 视频内容在渲染容器中的显示模式。
  */
 declare enum VideoContentMode {
-    /** 等比完整显示，允许容器留空。 */
+    /**
+     * 等比完整显示，允许容器留空。
+     */
     fit = "fit",
-    /** 等比铺满容器，允许裁剪画面。 */
+    /**
+     * 等比铺满容器，允许裁剪画面。
+     */
     fill = "fill"
 }
 

package/dist/{VideoContentMode-BXkqM4XG.d.ts → VideoContentMode-BM97_H8V.d.ts}

@@ -2,34 +2,74 @@
  * 实时视频的编码策略偏好。
  */
 declare enum RealtimeVideoEncoderPreference {
-    /** 优先保障帧率（弱网降分辨率）。 */
+    /**
+     * 优先保障帧率（弱网降分辨率）。
+     */
     maintainFramerate = "maintainFramerate",
-    /** 优先保障分辨率（弱网降帧率）。 */
+    /**
+     * 优先保障分辨率（弱网降帧率）。
+     */
     maintainQuality = "maintainQuality"
 }
 interface RealtimeVideoFormatInit {
-    /** 视频宽度，单位为像素。 */
+    /**
+     * 视频宽度，单位为像素。
+     */
     width: number;
-    /** 视频高度，单位为像素。 */
+    /**
+     * 视频高度，单位为像素。
+     */
     height: number;
-    /** 视频帧率，必须大于 0。 */
+    /**
+     * 视频帧率，必须大于 0。
+     */
     fps: number;
-    /** 最低上传码率，单位为 kbps；缺省使用 SDK 默认值，0 表示不设最低码率。 */
+    /**
+     * 最低上传码率，单位为 kbps；缺省使用 SDK 默认值，0 表示不设最低码率。
+     */
     minimumBitrate?: number;
-    /** 最高上传码率，单位为 kbps；缺省使用 SDK 默认值，指定时必须大于 0。 */
+    /**
+     * 最高上传码率，单位为 kbps；缺省使用 SDK 默认值，指定时必须大于 0。
+     */
     maximumBitrate?: number;
-    /** 上传编码策略偏好，默认优先保障帧率。 */
+    /**
+     * 上传编码策略偏好，默认优先保障帧率。
+     */
     encoderPreference?: RealtimeVideoEncoderPreference;
 }
 /**
  * 实时视频的尺寸、帧率和上传编码配置。
  */
 declare class RealtimeVideoFormat {
+    /**
+     * 视频规格
+     */
+    /**
+     * 视频宽度，单位为像素。
+     */
     readonly width: number;
+    /**
+     * 视频高度，单位为像素。
+     */
     readonly height: number;
+    /**
+     * 视频帧率，单位为 fps。
+     */
     readonly fps: number;
+    /**
+     * 上传编码配置
+     */
+    /**
+     * 最低上传码率，单位为 kbps；未指定时由 SDK 计算，0 表示不设最低码率。
+     */
     readonly minimumBitrate?: number;
+    /**
+     * 最高上传码率，单位为 kbps；未指定时由 SDK 计算。
+     */
     readonly maximumBitrate?: number;
+    /**
+     * 弱网下优先保障帧率或分辨率的编码策略。
+     */
     readonly encoderPreference: RealtimeVideoEncoderPreference;
     /**
      * 创建实时视频格式。
@@ -47,7 +87,9 @@ declare class RealtimeVideoFormat {
      * @throws 尺寸、帧率或码率配置无效时抛出错误。
      */
     validate(): void;
-    /** 调整尺寸，保留帧率和上传编码配置。 */
+    /**
+     * 调整尺寸，保留帧率和上传编码配置。
+     */
     resized(width: number, height: number): RealtimeVideoFormat;
 }
 
@@ -58,18 +100,28 @@ declare class RealtimeVideoFormat {
  * 摄像头，back 会回退到可用设备。
  */
 declare enum CameraPosition {
-    /** 前置摄像头（面向用户）。 */
+    /**
+     * 前置摄像头（面向用户）。
+     */
     front = "front",
-    /** 后置摄像头（面向环境）。 */
+    /**
+     * 后置摄像头（面向环境）。
+     */
     back = "back"
 }
 
 interface RealtimeVideoTrackInit {
-    /** 视频轨道标识。 */
+    /**
+     * 视频轨道标识。
+     */
     id: string;
-    /** 轨道当前使用的视频格式。 */
+    /**
+     * 轨道当前使用的视频格式。
+     */
     videoFormat?: RealtimeVideoFormat;
-    /** 本地相机轨道的摄像头位置。 */
+    /**
+     * 本地相机轨道的摄像头位置。
+     */
     position?: CameraPosition;
 }
 /**
@@ -79,9 +131,20 @@ interface RealtimeVideoTrackInit {
  * 渲染层通过它把画面绑定到 `<video>` 元素。
  */
 declare class RealtimeVideoTrack {
-    /** 视频轨道标识。 */
+    /**
+     * 轨道信息
+     */
+    /**
+     * 视频轨道标识。
+     */
     readonly id: string;
+    /**
+     * 动态元数据
+     */
     private metadata;
+    /**
+     * 平台资源
+     */
     /**
      * SDK 内部：轨道对应的 Web 媒体轨。
      * 本地轨道在采集启动后可用；远端轨道在订阅成功后可用。
@@ -95,13 +158,21 @@ declare class RealtimeVideoTrack {
      * @param init.position 本地相机轨道的初始摄像头位置。
      */
     constructor(init: RealtimeVideoTrackInit);
-    /** 当前视频轨道使用的视频格式。 */
+    /**
+     * 当前视频轨道使用的视频格式。
+     */
     get videoFormat(): RealtimeVideoFormat | undefined;
-    /** 本地相机轨道当前使用的摄像头位置。 */
+    /**
+     * 本地相机轨道当前使用的摄像头位置。
+     */
     get position(): CameraPosition | undefined;
-    /** 更新轨道视频格式。 @internal */
+    /**
+     * 更新轨道视频格式。 @internal
+     */
     updateVideoFormat(videoFormat: RealtimeVideoFormat): void;
-    /** 更新轨道摄像头位置。 @internal */
+    /**
+     * 更新轨道摄像头位置。 @internal
+     */
     updatePosition(position: CameraPosition): void;
 }
 
@@ -109,9 +180,13 @@ declare class RealtimeVideoTrack {
  * 视频内容在渲染容器中的显示模式。
  */
 declare enum VideoContentMode {
-    /** 等比完整显示，允许容器留空。 */
+    /**
+     * 等比完整显示，允许容器留空。
+     */
     fit = "fit",
-    /** 等比铺满容器，允许裁剪画面。 */
+    /**
+     * 等比铺满容器，允许裁剪画面。
+     */
     fill = "fill"
 }