@volcengine/vepusher 2.0.4-rc.8 → 2.0.4-rc.9

package/dist/index.es.d.ts

@@ -53,8 +53,120 @@ declare type ConfigOptions = {
      *        - `webTransport`: Streaming with WebTransport protocol.
      */
     mode?: PushMode;
+    /** {zh}
+     * @brief 推流中断重试配置，包含是否开启，重试最大超时时间，不传入时默认开启断线重连，最大超时时间默认3分钟
+     */
+    /** {en}
+     * @brief Push stream interruption retry configuration, including whether to enable, maximum retry timeout time, and default to enabling reconnection, maximum timeout time default 3 minutes.
+     */
+    reconnectConfig?: {
+        /** {zh}
+         * @brief 是否开启断线重连。
+         */
+        /** {en}
+         * @brief Whether to enable reconnection after disconnection.
+         */
+        enable: boolean;
+        /** {zh}
+         * @brief 最大重试超时时间，单位为秒。
+         */
+        /** {en}
+         * @brief Maximum retry timeout time, in seconds.
+         */
+        maxTimeout?: number;
+    };
+    /** {zh}
+     * @brief 推流日志配置, 默认自动开启日志上报。
+     */
+    /** {en}
+     * @brief Streaming log configuration, default automatic log reporting.
+     */
+    loggerConfig?: {
+        /** {zh}
+         * @brief 是否开启日志上报。
+         */
+        /** {en}
+         * @brief Whether to enable log reporting.
+         */
+        enable: boolean;
+        /** {zh}
+         * @brief 火山引擎的账号id，用于日志上报排查。
+         */
+        /** {en}
+         * @brief Byteplus account ID for log reporting.
+         */
+        accountId: number;
+        /** {zh}
+         * @brief 应用 ID。登录视频直播控制台 > SDK 管理查询。
+         */
+        /** {en}
+         * @brief Application ID. Query in the SDK Management section of the Byteplus MediaLive Broadcast Console.
+         */
+        appId?: number;
+        /** {zh}
+         * @brief 应用名称。
+         */
+        /** {en}
+         * @brief Application name.
+         */
+        appName?: string;
+        /** {zh}
+         * @brief 用于识别单一用户的 ID，如不设置，会随机生成一个用户 ID 存在浏览器缓存中。
+         */
+        /** {en}
+         * @brief User ID for identifying a single user. If not set, a random user ID will be generated and stored in the browser cache.
+         */
+        userId?: string;
+        /** {zh}
+         * @brief 用于识别用户设备的 ID，如不设置，会随机生成一个用户 ID 存在浏览器缓存中。
+         */
+        /** {en}
+         * @brief User device ID. If not set, a random user ID will be generated and stored in the browser cache.
+         */
+        deviceId?: string;
+        showInConsole?: boolean;
+    };
+    checkAudio?: boolean;
 };
 
+/** {zh}
+ * @detail events
+ * @brief 直播链接状态码
+ */
+/** {en}
+ *
+ */
+declare enum ConnectionState {
+    /** {zh}
+     * @brief 断开连接，默认时断开连接。
+     */
+    /** {en}
+     * @brief Disconnected by default.
+     */
+    DISCONNECTED = 0,
+    /** {zh}
+     * @brief 连接中。
+     */
+    /** {en}
+     * @brief Connecting.
+     */
+    CONNECTING = 1,
+    /** {zh}
+     * @brief 已连接。
+     */
+    /** {en}
+     * @brief Connected.
+     */
+    CONNECTED = 2,
+    /** {zh}
+     * @brief 重连中。
+     */
+    /** {en}
+     * @brief Reconnecting.
+     */
+    RECONNECTING = 3,
+}
+
 /** {zh}
  * @detail config
  * @list config
@@ -180,21 +292,31 @@ declare interface IProperty {
      */
     setVideoFps: number;
     /** {zh}
-     * @brief 设置推流视频的码率，单位为 kbps。
+     * @deprecated
+     * @brief 设置推流视频的码率，单位为 bps。
      */
     /** {en}
-     *
-     * @brief Set the push stream video bitrate in kbps.
+     * @deprecated
+     * @brief Set the push stream video bitrate in bps.
      */
     setVideoBitrate: number;
     /** {zh}
-     * @brief 设置推流时音频的码率，单位为 kbps。
+     * @brief 设置推流时视频的码率，单位为 kbps。
+     */
+    setVideoKBitrate: number;
+    /** {zh}
+     * @deprecated
+     * @brief 设置推流时音频的码率，单位为 bps。
      */
     /** {en}
-     *
-     * @brief Set the audio bitrate for push stream in kbps.
+     * @deprecated
+     * @brief Set the audio bitrate for push stream in bps.
      */
     setAudioBitrate: number;
+    /** {zh}
+     * @brief 设置推流时音频的码率，单位为 kbps。
+     */
+    setAudioKBitrate: number;
     /** {zh}
      * @brief 设置麦克风采集的采样率，单位为 Hz。
      */
@@ -218,6 +340,17 @@ declare interface IProperty {
      *
      */
     setVolumeDetectScriptUrl: string;
+    /** {zh}
+     * @hidden
+     * @brief 设置推流时默认采集的方向，默认是横屏
+     */
+    /** {zh}
+     * @brief 更新推流地址，作用：断线重连时会使用最新的推流地址，避免推流过程中推流地址超时鉴权失败。
+     */
+    /** {en}
+     * @brief Update the push stream address. The effect: When reconnecting, the latest push stream address will be used to avoid push stream address timeout authentication failure.
+     */
+    updatePushUrl: string;
 }
 
 declare type IVePusherEvents = {
@@ -301,6 +434,76 @@ declare interface IVideoStreamLayoutParams {
      * @brief When the video stream contains audio content, the corresponding audio volume ranges from `[0,100]`.
      */
     volume?: number;
+    /** {zh}
+     * @brief 镜像类型，默认为不镜像。
+     */
+    mirrorType?: MirrorType;
+}
+
+/** {zh}
+ * @detail api
+ * @brief 视频流渲染的配置信息
+ * @id IVideoStreamRenderConfig
+ * @name IVideoStreamRenderConfig
+ */
+/** {en}
+ * @detail api
+ * @id IVideoStreamRenderConfig
+ * @name IVideoStreamRenderConfig
+ *
+ */
+declare interface IVideoStreamRenderConfig {
+    /** {zh}
+     * @brief 配置的渲染宽度。
+     */
+    /** {en}
+     * @brief The configured rendering width.
+     */
+    width: number;
+    /** {zh}
+     * @brief 配置的渲染高度。
+     */
+    /** {en}
+     * @brief The configured rendering height.
+     */
+    height: number;
+    /** {zh}
+     * @brief 实际渲染宽度，（addVideoStream时使用keepRatio，实际渲染宽度可能会根据实际采集的宽高等比例缩放）。
+     *
+     */
+    /** {en}
+     * @brief The actual rendering width. (When adding a video stream, the actual rendering width may be scaled proportionally based on the actual width and height of the video stream.)
+     */
+    paintWidth: number;
+    /** {zh}
+     * @brief 实际渲染高度，（addVideoStream时使用keepRatio，实际渲染高度可能会根据实际采集的宽高等比例缩放）。
+     *
+     */
+    /** {en}
+     * @brief The actual rendering height. (When adding a video stream, the actual rendering height may be scaled proportionally based on the actual width and height of the video stream.)
+     */
+    paintHeight: number;
+    /** {zh}
+     * @brief 渲染的x坐标。
+     */
+    /** {en}
+     *  @brief The rendering x-coordinate.
+     */
+    x: number;
+    /** {zh}
+     * @brief 渲染的y坐标。
+     */
+    /** {en}
+     * @brief The rendering y-coordinate.
+     */
+    y: number;
+    /** {zh}
+     * @brief 渲染的层级。
+     */
+    /** {en}
+     * @brief The rendering layer.
+     */
+    zOrder: number;
 }
 
 /** {zh}
@@ -318,6 +521,7 @@ declare class LivePusher extends default_2<RTMEvents> {
     private _streamComposeController;
     private _streamConsumeController;
     private _observer;
+    private _options;
     /** {zh}
      * @brief 查询是否支持 RTM 或 WebTransport 推流。
      * @param mode 推流模式。
@@ -331,7 +535,7 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @return - `true`: The specified streaming mode is supported.
      *         - `false`: The specified streaming mode is not supported.
      */
-    static isSupported(mode: PushMode): Promise<boolean>;
+    static isSupported(mode: PushMode): Promise<boolean | undefined>;
     /** {zh}
      * @brief 创建一个新的 `LivePusher` 实例。
      * @param options 配置选项，定义推流相关的参数。
@@ -722,6 +926,15 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @param config Attributes of the mixing canvas, such as width, height, frame rate, etc.
      */
     setMixingConfig(config: IMixingViewConfig): void;
+    /** {zh}
+     * @brief 获取配置的合流参数，包括合流画布的宽度、高度、帧率等。
+     * @return 返回配置的合流参数。
+     */
+    /** {en}
+     * @brief Get the configured mixing parameters, including the width, height, and frame rate of the mixing canvas.
+     * @return Returns the configured mixing parameters.
+     */
+    getMixingConfig(): IMixingViewConfig;
     /** {zh}
      * @brief 设置视频的预览区域。本地视频会在指定的容器内进行预览，同时预览内容与推流的画面和声音完全一致。
      * @param containerId 用于指定预览区域的 HTML 容器元素 ID。
@@ -936,6 +1149,14 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @return 对应流的 `MediaStream` 对象，可用于本地渲染或其他处理。
      */
     getMediaStream(streamId: string): MediaStream;
+    /** {zh}
+     *  @hidden
+     * @brief 获取原始的Stream对象
+     */
+    /** {en}
+     * @hidden
+     */
+    getStream(streamId: string): any;
     /** {zh}
      * @brief 停止推流。
      * @return 返回 `Promise` 对象。
@@ -984,6 +1205,7 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @return `video` element of the preview screen.
      */
     getPreviewElement(): HTMLVideoElement | null | undefined;
+    getVideoStreamRenderConfig(streamId: string): IVideoStreamRenderConfig | undefined;
     private _bindEvent;
     /** {zh}
      * @brief 清理 SDK 实例，避免可能会产生的内存泄露。
@@ -1044,6 +1266,33 @@ declare class LivePusher extends default_2<RTMEvents> {
 }
 export default LivePusher;
 
+/** {zh}
+ * @detail config
+ * @list config
+ * @brief 视频流镜像方向
+ * @id MirrorType
+ * @name MirrorType
+ */
+declare enum MirrorType {
+    /** {zh}
+     * @brief 左右镜像
+     */
+    LeftToRight = "LeftToRight",
+    /** {zh}
+     * @brief 上下镜像
+     */
+    UpToDown = "UpToDown",
+    /** {zh}
+     * @brief 左右+上下镜像
+     */
+    All = "All",
+    /**
+     * {zh}
+     * @brief 不镜像
+     */
+    None = "None"
+}
+
 /** {zh}
  * @detail events
  * @list events
@@ -1163,6 +1412,49 @@ declare class Observer implements IVePusherEvents {
      * @notes The callback will be triggered when stopping capture actively or when capture stops passively due to an internal error.
      */
     onStopCapture: (streamId: string) => void;
+    /** {zh}
+     * @brief 推流过程中直播连接状态变化的回调。
+     */
+    /** {en}
+     * @brief Callback for changes in the live connection state during the streaming process.
+     */
+    onLiveConnectStateChange: (state: ConnectionState) => void;
+    /** {zh}
+     * @brief 推流过程中重连状态变化的回调。params中failedCode在失败时会返回，提示重连失败的原因。retryTime在重连等待和重连中会返回，提示当前为第几次重连。waitingTime在重连等待中会返回，提示当前等待的时间，单位为毫秒，两次重连中会等待一定时间，根据重连次数增加等待时间会增加，最大为10秒。
+     */
+    /** {en}
+     *  @brief Callback for changes in the reconnect state during the streaming process. params will return failedCode when the connection fails, indicating the reason for the failure. retryTime will return the current retry times when the connection is in the waiting or reconnecting state, indicating the current retry times. waitingTime will return the waiting time when the connection is in the waiting state, in milliseconds, and the waiting time will increase with the number of retries, up to a maximum of 10 seconds.
+     */
+    onReconnectStateChange: (
+    /** {zh}
+     * @brief 重连状态。
+     */
+    /** {en}
+     * @brief Reconnect state.
+     */
+    state: ReconnectState, params?: {
+        /** {zh}
+         * @brief 重连失败时返回的失败错误码。
+         */
+        /** {en}
+         * @brief The error code returned when the connection fails.
+         */
+        failedCode?: ReconnectFailedCode;
+        /** {zh}
+         * @brief 重连等待中、重连中的当前重试次数。
+         */
+        /** {en}
+         * @brief The current retry times in the waiting or reconnecting state.
+         */
+        retryTime?: number;
+        /** {zh}
+         * @brief 重连等待中的当前等待时间，单位为毫秒。
+         */
+        /** {en}
+         * @brief The current waiting time in the waiting state, in milliseconds.
+         */
+        waitingTime?: number;
+    }) => void;
     /** {zh}
      * @brief 构造函数
      * @hidden
@@ -1186,7 +1478,73 @@ declare class Observer implements IVePusherEvents {
  *        - `webTransport`: Use WebTransport for streaming.
  * @brief Streaming Mode
  */
-declare type PushMode = 'rtm' | 'webTransport';
+declare type PushMode = 'rtm' | 'webTransport' | 'mediaEngine';
+
+/** {zh}
+ * @detail events
+ * @brief 重连重连失败码
+ */
+declare enum ReconnectFailedCode {
+    /** {zh}
+     * @brief 推流地址失效，需要重新生成推流地址推流
+     */
+    /** {en}
+     * @brief The push stream address is invalid and needs to regenerate the push stream address to push
+     */
+    PushUrlInvalid = 1001,
+    /** {zh}
+     * @brief 重连超时
+     */
+    /** {en}
+     * @brief Reconnect timeout
+     */
+    ReconnectTimeout = 1002,
+}
+
+/** {zh}
+ *  @detail events
+ *  @brief 推流重连状态码
+ */
+/** {en}
+ *
+ */
+declare enum ReconnectState {
+    /** {zh}
+     * @brief 重连开始。
+     */
+    /** {en}
+     * @brief Reconnect start.
+     */
+    START = 1,
+    /** {zh}
+     * @brief 重连等待。
+     */
+    /** {en}
+     *  @brief Reconnect waiting.
+     */
+    WAITING = 2,
+    /** {zh}
+     * @brief 重连中。
+     */
+    /** {en}
+     * @brief Reconnecting.
+     */
+    RECONNECTING = 3,
+    /** {zh}
+     * @brief 重连成功。
+     */
+    /** {en}
+     * @brief Reconnect success.
+     */
+    SUCCESS = 4,
+    /** {zh}
+     * @brief 重连失败。
+     */
+    /** {en}
+     * @brief Reconnect failed.
+     */
+    FAILED = 5,
+}
 
 declare class RTMError extends Error {
     code: RTMErrorCode;
@@ -1283,7 +1641,8 @@ declare enum RTMErrorCode {
      *
      * @brief Stream connection failed. This error will be returned if the network connection fails or the server address is unreachable.
      */
-    PUSH_CONNECT_FAILED = 2003
+    PUSH_CONNECT_FAILED = 2003,
+    AUDIO_RESUME_FAILED = 2004
 }
 
 declare type RTMEvents = {
@@ -1540,6 +1899,10 @@ declare type StatsSnapshoot = {
          * @brief Encoded frames.
          */
         framesEncoded: number;
+        /** {zh}
+         * @brief 编码的视频帧率
+         */
+        framesEncodedPerSecond: number;
         /** {zh}
          * @brief 已编码的关键帧数。
          */
@@ -1620,6 +1983,10 @@ declare type StatsSnapshoot = {
          * @brief Packet loss rate.
          */
         packetsLostPercent: number;
+        /** {zh}
+         * @brief 计算周期
+         */
+        deltaTime?: number;
     };
     audio?: {
         /** {zh}
@@ -1678,6 +2045,7 @@ declare type StatsSnapshoot = {
          * @brief Packet loss rate.
          */
         packetsLostPercent: number | undefined;
+        deltaAudioEnergy?: number;
     };
 };