@xmaxai/web-sdk 1.0.10 → 1.1.0

package/dist/{TrajectoryEffectRendering-BKKPO7Uk.d.ts → TrajectoryEffectRendering-BdSJxHQw.d.ts}

@@ -11,6 +11,9 @@ declare enum RealtimeVideoEncoderPreference {
      */
     maintainQuality = "maintainQuality"
 }
+/**
+ * 视频尺寸、帧率和上传编码选项。
+ */
 interface RealtimeVideoFormatInit {
     /**
      * 视频宽度，单位为像素。
@@ -25,7 +28,7 @@ interface RealtimeVideoFormatInit {
      */
     fps: number;
     /**
-     * 最低上传码率，单位为 kbps；缺省使用 SDK 默认值，0 表示不设最低码率。
+     * 最低上传码率，单位为 kbps；缺省取 500 与最高码率的较小值，0 表示不设下限。
      */
     minimumBitrate?: number;
     /**
@@ -41,9 +44,6 @@ interface RealtimeVideoFormatInit {
  * 实时视频的尺寸、帧率和上传编码配置。
  */
 declare class RealtimeVideoFormat {
-    /**
-     * 视频规格
-     */
     /**
      * 视频宽度，单位为像素。
      */
@@ -57,10 +57,7 @@ declare class RealtimeVideoFormat {
      */
     readonly fps: number;
     /**
-     * 上传编码配置
-     */
-    /**
-     * 最低上传码率，单位为 kbps；缺省为 100，0 表示不设最低码率；仅支持该参数的 RTC 链路生效。
+     * 最低上传码率，单位为 kbps；缺省取 500 与最高码率的较小值，0 表示不设下限；仅支持该参数的 RTC 链路生效。
      */
     readonly minimumBitrate?: number;
     /**
@@ -73,13 +70,6 @@ declare class RealtimeVideoFormat {
     readonly encoderPreference: RealtimeVideoEncoderPreference;
     /**
      * 创建实时视频格式。
-     *
-     * @param init.width 视频宽度，单位为像素。
-     * @param init.height 视频高度，单位为像素。
-     * @param init.fps 视频帧率，必须大于 0。
-     * @param init.minimumBitrate 最低上传码率，单位为 kbps；缺省为 100，仅支持该参数的 RTC 链路生效。
-     * @param init.maximumBitrate 最高上传码率，单位为 kbps；缺省按最终上传尺寸和帧率计算。
-     * @param init.encoderPreference 上传编码策略偏好，默认值为 maintainFramerate。
      */
     constructor(init: RealtimeVideoFormatInit);
     /**
@@ -110,6 +100,9 @@ declare enum CameraPosition {
     back = "back"
 }
 
+/**
+ * 视频轨道身份及初始媒体信息。
+ */
 interface RealtimeVideoTrackInit {
     /**
      * 视频轨道标识。
@@ -131,9 +124,6 @@ interface RealtimeVideoTrackInit {
  * 渲染层通过它把画面绑定到 `<video>` 元素。
  */
 declare class RealtimeVideoTrack {
-    /**
-     * 轨道信息
-     */
     /**
      * 视频轨道标识。
      */
@@ -142,9 +132,6 @@ declare class RealtimeVideoTrack {
      * 动态元数据
      */
     private metadata;
-    /**
-     * 平台资源
-     */
     /**
      * SDK 内部：轨道对应的 Web 媒体轨。
      * 本地轨道在采集启动后可用；远端轨道在订阅成功后可用。
@@ -152,10 +139,6 @@ declare class RealtimeVideoTrack {
     mediaStreamTrack?: MediaStreamTrack;
     /**
      * 创建实时视频轨道。
-     *
-     * @param init.id 视频轨道标识。
-     * @param init.videoFormat 轨道初始视频格式。
-     * @param init.position 本地相机轨道的初始摄像头位置。
      */
     constructor(init: RealtimeVideoTrackInit);
     /**
@@ -195,21 +178,17 @@ declare enum VideoContentMode {
  */
 interface VideoRenderStatistics {
     /**
-     * video 按浏览器 presentedFrames 增量计数；canvas 按实际呈现提交计数。
+     * 按浏览器 presentedFrames 增量计数的视频呈现来源。
      */
-    readonly source: "video" | "canvas";
+    readonly source: "video";
     /**
-     * 原帧与插值帧的总呈现帧率，单位 fps。
+     * 视频呈现帧率，单位 fps。
      */
     readonly frameRate: number;
     /**
      * 原帧呈现帧率，单位 fps。
      */
     readonly originalFrameRate: number;
-    /**
-     * 插值帧呈现帧率，单位 fps；未开启插帧时为 0。
-     */
-    readonly interpolatedFrameRate: number;
 }
 
 /**
@@ -220,15 +199,27 @@ type TrajectoryID = number;
  * 供视觉效果使用的触点；location 为视口 CSS 像素，timestamp 为毫秒。
  */
 interface TrajectoryPoint {
+    /**
+     * 同一触点在连续采样期间保持不变的轨迹标识。
+     */
     readonly id: TrajectoryID;
+    /**
+     * 触点在视口中的位置，单位为 CSS 像素。
+     */
     readonly location: Readonly<{
         x: number;
         y: number;
     }>;
+    /**
+     * 触点在视口中的归一化位置，横纵范围为 0–1。
+     */
     readonly normalizedLocation: Readonly<{
         x: number;
         y: number;
     }>;
+    /**
+     * 触点采样时的单调时钟时间，单位为毫秒。
+     */
     readonly timestamp: number;
 }
 
@@ -259,4 +250,4 @@ interface TrajectoryEffectRendering {
     reset(): void;
 }
 
-export { CameraPosition as C, RealtimeVideoFormat as R, type TrajectoryEffectRendering as T, VideoContentMode as V, RealtimeVideoTrack as a, type VideoRenderStatistics as b, RealtimeVideoEncoderPreference as c, type RealtimeVideoFormatInit as d, type TrajectoryID as e, type TrajectoryPoint as f };
+export { CameraPosition as C, RealtimeVideoFormat as R, type TrajectoryEffectRendering as T, VideoContentMode as V, RealtimeVideoTrack as a, type VideoRenderStatistics as b, type TrajectoryPoint as c, type TrajectoryID as d, RealtimeVideoEncoderPreference as e, type RealtimeVideoFormatInit as f };