@volcengine/vepusher 2.0.4-rc.1 → 2.0.4-rc.3

package/dist/index.es.d.ts

@@ -1,10 +1,28 @@
+import { AudioTrack } from '@byted/ve-capture';
 import { default as default_2 } from 'eventemitter3';
+import { EventEmitter } from 'eventemitter3';
+import { MediaAudioTrack } from '@byted/ve-capture';
+import { MediaVideoTrack } from '@byted/ve-capture';
+import { PictureTrack } from '@byted/ve-capture';
+import { ScreenAudioTrack } from '@byted/ve-capture';
+import { ScreenVideoTrack } from '@byted/ve-capture';
+import { TrackSourceMixerNode } from '@byted/ve-capture';
+import { TrackSourceViewNode } from '@byted/ve-capture';
+import { VideoTrack } from '@byted/ve-capture';
+import { ViewConfig } from '@byted/ve-capture';
 
 declare enum AUDIO_DEFAULT_QUALITY {
     STANDARD = "48000x40",
     HIGH = "48000x128"
 }
 
+declare abstract class AudioStream extends Stream {
+    abstract get mixerNode(): TrackSourceMixerNode | null;
+    abstract destroy(): void;
+    get isVideoStream(): boolean;
+    get isAudioStream(): boolean;
+}
+
 /** {zh}
  * @detail config
  * @list config
@@ -53,8 +71,28 @@ declare type ConfigOptions = {
      *        - `webTransport`: Streaming with WebTransport protocol.
      */
     mode?: PushMode;
+    /** {zh}
+     * @brief 推流中断重试配置，包含是否开启，重试最大超时时间，不传入时默认开启断线重连，最大超时时间默认3分钟
+     */
+    reconnectConfig?: {
+        /** {zh}
+         * @brief 是否开启断线重连
+         */
+        enable: boolean;
+        /** {zh}
+         * @brief 最大重试超时时间，单位为 s
+         */
+        maxTimeout?: number;
+    };
 };
 
+declare enum ConnectionState {
+    DISCONNECTED = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    RECONNECTING = 3,
+}
+
 /** {zh}
  * @detail config
  * @list config
@@ -218,6 +256,15 @@ declare interface IProperty {
      *
      */
     setVolumeDetectScriptUrl: string;
+    /** {zh}
+     * @hidden
+     * @brief 设置推流时默认采集的方向，默认是横屏
+     */
+    /**
+     * {zh}
+     * @brief 更新推流地址，作用：断线重连时会使用最新的推流地址，避免推流过程中推流地址超时
+     */
+    updatePushUrl: string;
 }
 
 declare type IVePusherEvents = {
@@ -301,6 +348,10 @@ 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}
@@ -722,6 +773,7 @@ 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;
+    getMixingConfig(): ViewConfig;
     /** {zh}
      * @brief 设置视频的预览区域。本地视频会在指定的容器内进行预览，同时预览内容与推流的画面和声音完全一致。
      * @param containerId 用于指定预览区域的 HTML 容器元素 ID。
@@ -936,6 +988,7 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @return 对应流的 `MediaStream` 对象，可用于本地渲染或其他处理。
      */
     getMediaStream(streamId: string): MediaStream;
+    getStream(streamId: string): VideoStream | AudioStream;
     /** {zh}
      * @brief 停止推流。
      * @return 返回 `Promise` 对象。
@@ -984,6 +1037,15 @@ declare class LivePusher extends default_2<RTMEvents> {
      * @return `video` element of the preview screen.
      */
     getPreviewElement(): HTMLVideoElement | null | undefined;
+    getVideoStreamRenderConfig(streamId: string): {
+        width: number;
+        height: number;
+        paintWidth: number;
+        paintHeight: number;
+        x: number;
+        y: number;
+        zOrder: number;
+    } | undefined;
     private _bindEvent;
     /** {zh}
      * @brief 清理 SDK 实例，避免可能会产生的内存泄露。
@@ -1044,6 +1106,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 +1252,12 @@ 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;
+    onLiveConnectStateChange: (state: ConnectionState) => void;
+    onReconnectStateChange: (state: ReconnectState, params?: {
+        failedCode?: ReconnectFailedCode;
+        retryTime?: number;
+        waitingTime?: number;
+    }) => void;
     /** {zh}
      * @brief 构造函数
      * @hidden
@@ -1188,6 +1283,21 @@ declare class Observer implements IVePusherEvents {
  */
 declare type PushMode = 'rtm' | 'webTransport';
 
+declare enum ReconnectFailedCode {
+    // 推流地址失效，需要重新生成推流地址推流
+    PushUrlInvalid = 1001,
+    // 重连超时
+    ReconnectTimeout = 1002,
+}
+
+declare enum ReconnectState {
+    START = 1,
+    WAITING = 2,
+    RECONNECTING = 3,
+    SUCCESS = 4,
+    FAILED = 5,
+}
+
 declare class RTMError extends Error {
     code: RTMErrorCode;
     message: string;
@@ -1681,6 +1791,62 @@ declare type StatsSnapshoot = {
     };
 };
 
+declare abstract class Stream extends EventEmitter<StreamEvents> {
+    type: StreamType;
+    id: string;
+    protected _volumeDetector?: VolumeDetect | null;
+    protected _width: number;
+    protected _height: number;
+    protected _mediaStream: MediaStream | null;
+    protected _source?: MediaStream | MediaStreamTrack | VideoTrack | MediaVideoTrack | MediaAudioTrack | ScreenVideoTrack | ScreenAudioTrack | AudioTrack | PictureTrack | Array<MediaVideoTrack | MediaAudioTrack> | Array<ScreenVideoTrack | ScreenAudioTrack>;
+    protected _nextStream: Stream | null;
+    protected _trackMap: {
+        video?: MediaStreamTrack;
+        audio?: MediaStreamTrack;
+    };
+    constructor(params: {
+        type: StreamType;
+        stream: MediaStream | MediaStreamTrack | VideoTrack | MediaVideoTrack | MediaAudioTrack | ScreenVideoTrack | ScreenAudioTrack | AudioTrack | PictureTrack | Array<MediaVideoTrack | MediaAudioTrack> | Array<ScreenVideoTrack | ScreenAudioTrack>;
+    });
+    get source(): MediaStreamTrack | AudioTrack | MediaStream | MediaAudioTrack | ScreenAudioTrack | VideoTrack | PictureTrack | ScreenVideoTrack | MediaVideoTrack | (ScreenAudioTrack | ScreenVideoTrack)[] | (MediaAudioTrack | MediaVideoTrack)[] | undefined;
+    get videoTrack(): MediaStreamTrack | undefined;
+    get audioTrack(): MediaStreamTrack | undefined;
+    get width(): number;
+    get height(): number;
+    get isVideoStream(): boolean;
+    get mediaStream(): MediaStream;
+    abstract bindTrackEnd(callback: () => void): void;
+    startVolumeDetect(): Promise<void>;
+    stopVolumeDetect(): void;
+    get volume(): number;
+}
+
+declare type StreamEvents = {
+    [StreamEventTypes.SizeChange]: ({ width, height, }: {
+        width: number;
+        height: number;
+    }) => void;
+};
+
+declare const StreamEventTypes: {
+    readonly SizeChange: "sizeChange";
+};
+
+declare type StreamEventTypes = typeof StreamEventTypes;
+
+declare enum StreamType {
+    Camera = "camera",
+    Screen = "screen",
+    VideoFile = "videoFile",
+    Microphone = "microphone",
+    AudioFile = "audioFile",
+    Image = "image",
+    MixAudio = "mixAudio",
+    MixVideo = "mixVideo",
+    CustomVideo = "customVideo",
+    CustomAudio = "customAudio"
+}
+
 /** {zh}
  * @detail config
  * @brief 内置的推流视频质量。
@@ -1765,4 +1931,21 @@ declare enum VIDEO_DEFAULT_QUALITY {
     '1080p-3' = "1920x1080x30x3150"
 }
 
+declare abstract class VideoStream extends Stream {
+    abstract get viewNode(): TrackSourceViewNode | null;
+    abstract get mixerNode(): TrackSourceMixerNode | null;
+    abstract destroy(): void;
+    get isVideoStream(): boolean;
+    get isAudioStream(): boolean;
+    protected bindTrackSizeChangeEvent(stream: VideoTrack): void;
+}
+
+declare class VolumeDetect {
+    _audioCtx: AudioContext | null;
+    _volume: number;
+    get volume(): number;
+    start(audioTrack: MediaStreamTrack, workletUrl?: string): Promise<void>;
+    stop(): void;
+}
+
 export { }