trtc-electron-sdk 10.3.404 → 10.6.115-beta.1

package/liteav/LocalMediaTranscoder/index.d.ts

@@ -0,0 +1,359 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, Rect, TRTCVideoEncParam, TRTCVideoPixelFormat, TRTCRenderParams } from '../trtc_define';
+export declare enum TRTCLocalMediaTranscodingEvents {
+    onTranscodingStarted = "onTranscodingStarted",
+    onTranscodingStopped = "onTranscodingStopped",
+    onCameraSourceStarted = "onCameraSourceStarted",
+    onCameraSourceStopped = "onCameraSourceStopped",
+    onImageSourceStarted = "onImageSourceStarted",
+    onImageSourceStopped = "onImageSourceStopped",
+    onScreenSourceStarted = "onScreenSourceStarted",
+    onScreenSourcePaused = "onScreenSourcePaused",
+    onScreenSourceResumed = "onScreenSourceResumed",
+    onScreenSourceStopped = "onScreenSourceStopped"
+}
+export declare enum TRTCLocalMediaTranscodingSourceType {
+    MediaSourceCamera = 0,
+    MediaSourceScreen = 1,
+    MediaSourceImage = 2,
+    MediaSourceRemoteVideo = 3
+}
+/**
+ * 媒体源
+ * @typedef {Object} TRTCLocalMediaTranscodingSource - 媒体源
+ * @property {TRTCLocalMediaTranscodingSourceType} mode - 媒体类型
+ * @property {String} cameraDeviceId - 摄像头 ID，当 sourceType 为 MediaSourceCamera 时此字段有效，您可以使用该字段指定摄像头的设备 ID，摄像头的设备 ID 可以通过 TXDeviceManager 中的接口获取.
+ * @property {String} screenSourceId - 屏幕或窗口 ID，当 sourceType 为 MediaSourceScreen 时此字段有效，您可以使用该字段指定整个屏幕或者某个窗口的窗口 ID，您可以通过 TRTCCloud 中的 getScreenCaptureSources 接口获取可以被分享的窗口 ID。
+ * @property {String} imagePath - 图像的地址，当 sourceType 为 MediaSourceImage 时此字段有效，您可以使用该字段指定图片的文件路径，目前版本只支持 BMP、JPG、PNG、GIF 四种图像格式。
+ * @property {String} userId - 远端视频流的用户 ID，当 sourceType 为 MediaSourceRemoteVideo 时此字段有效，不过当前版本的 SDK 还不支持这个能力。
+ * @property {Rect} rect - 指定该路画面的坐标区域（单位：像素）。
+ * @property {Number} zOrder - 指定该路画面的层级（取值范围：0 - 15，不可重复）。
+ * @property {Boolean} mirror - 指定该路画面是否要开启左右镜像
+ */
+/**
+ * 媒体源
+ */
+export declare class TRTCLocalMediaTranscodingSource {
+    /**
+     * 【字段含义】媒体类型
+     * @property {TRTCLocalMediaTranscodingSourceType} sourceType
+     * @public
+     */
+    sourceType: TRTCLocalMediaTranscodingSourceType;
+    /**
+     * 【字段含义】摄像头 ID
+     * 当 sourceType 为 MediaSourceCamera 时此字段有效，您可以使用该字段指定摄像头的设备 ID，摄像头的设备 ID 可以通过 TXDeviceManager 中的接口获取
+     * @property {string} cameraDeviceId
+     * @public
+     */
+    cameraDeviceId?: string;
+    /**
+     *  【字段含义】屏幕或窗口 ID
+     * 当 sourceType 为 MediaSourceScreen 时此字段有效，您可以使用该字段指定整个屏幕或者某个窗口的窗口 ID，您可以通过 TRTCCloud 中的 getScreenCaptureSources 接口获取可以被分享的窗口 ID。
+     * @property {string} screenSourceId
+     * @public
+     */
+    screenSourceId?: string;
+    /**
+     * 【字段含义】图像的地址
+     * 当 sourceType 为 MediaSourceImage 时此字段有效，您可以使用该字段指定图片的文件路径，目前版本只支持 BMP、JPG、PNG、GIF 四种图像格式。
+     * @property {string} imagePath
+     * @public
+     */
+    imagePath?: string;
+    /**
+     *【字段含义】远端视频流的用户 ID
+     * 当 sourceType 为 MediaSourceRemoteVideo 时此字段有效，不过当前版本的 SDK 还不支持这个能力。
+     * @property {string} userId
+     * @public
+     */
+    userId?: string;
+    /**
+     * 【字段含义】指定该路画面的坐标区域（单位：像素）。
+     * @property {Rect} rect
+     * @public
+     */
+    rect: Rect;
+    /**
+     * 【字段含义】指定该路画面的层级（取值范围：0 - 15，不可重复）。
+     * @property {Number} zOrder
+     * @public
+     */
+    zOrder: number;
+    /**
+     * 【字段含义】指定该路画面是否要开启左右镜像
+     * @property {Boolean} mirror
+     * @public
+     */
+    mirror: boolean;
+    constructor();
+}
+/**
+ * 本地媒体流混流转码配置参数
+ * @typedef {Object} TRTCLocalMediaTranscodingParams - 本地媒体流混流转码配置参数
+ * @property {Array<TRTCLocalMediaTranscodingSource>} inputSourceList - 【字段含义】指定转码流中的每一路输入媒体源配置的信息。
+ * @property {TRTCVideoEncParam} videoEncoderParams - 【字段含义】转码流的视频编码参数
+ * @property {Number} canvasColor - 【字段含义】指定混合画面的底色。
+ */
+/**
+ * 本地媒体流混流转码配置参数
+ */
+export declare class TRTCLocalMediaTranscodingParams {
+    /**
+     * 【字段含义】指定转码流中的每一路输入媒体源配置的信息。
+     * 【推荐取值】该字段是一个 TRTCLocalMediaTranscodingSource  类型的数组，数组中的每一个元素都用来代表每一路输入媒体源的信息。
+     * 【特别说明】媒体源信息不支持留空，否则 TRTCLocalMediaoTranscodingCallback.onTranscodingStarted 会报错。
+     */
+    inputSourceList: TRTCLocalMediaTranscodingSource[];
+    /**
+     * 【字段含义】转码流的视频编码参数
+     */
+    videoEncoderParams: TRTCVideoEncParam;
+    /**
+     * 【字段含义】指定混合画面的底色。
+     * 【推荐取值】默认值：0x000000 代表黑色。格式为十六进制数字，比如：“0x61B9F1” 代表 RGB 分别为（97、158、241）。
+     */
+    canvasColor: number;
+    constructor();
+}
+export declare enum TRTCCameraCaptureMode {
+    CameraResolutionStrategyAuto = 0,
+    CameraResolutionStrategyPerformance = 1,
+    CameraResolutionStrategyHighQuality = 2,
+    CameraCaptureManual = 3
+}
+/**
+ * 摄像头采集参数，该设置能决定本地预览图像画质。
+ * @typedef {Object} TRTCCameraCaptureParams - 摄像头采集参数
+ * @property {mode} TRTCCameraCaptureMode - 摄像头采集偏好
+ * @property {width} Number - 采集图像宽度
+ * @property {height} Number - 采集图像高度
+ */
+/**
+ * 摄像头采集参数
+ *
+ * 该设置能决定本地预览图像画质。
+ */
+export declare class TRTCCameraCaptureParams {
+    /** 摄像头采集偏好 */
+    mode: TRTCCameraCaptureMode;
+    /** 采集图像宽度 */
+    width: number;
+    /** 采集图像高度 */
+    height: number;
+    constructor();
+}
+/**
+ * 本地混流转码类
+ * @extends EventEmitter
+ *
+ * @example
+ *   // 运行示例
+ *   import TRTCCloud, {
+ *    TRTCCameraCaptureMode,
+ *    TRTCVideoRotation,
+ *    TRTCVideoFillMode,
+ *    TRTCVideoMirrorType,
+ *    TRTCVideoStreamType,
+ *    TRTCLocalMediaTranscodingSourceType,
+ *    TRTCVideoResolution,
+ *    TRTCVideoResolutionMode,
+ *    TRTCVideoPixelFormat
+ *   } from 'trtc-electron-sdk';
+ *
+ *   const trtcCloud = new TRTCCloud();
+ *   const cameraList =trtcCloud.getCameraDevicesList();
+ *
+ *   // 获取本地合图转码推流对象
+ *   const localMediaTranscoder =trtcCloud.createLocalMediaTranscoder({
+ *     pixelFormat: TRTCVideoPixelFormat.TRTCVideoPixelFormat_I420,
+ *   });
+ *
+ *   // 注册事件监听
+ *   // 监听合图开始、结束事件
+ *   localMediaTranscoder.on('onTranscodingStarted', (errCode: number, errMsg: string) => {
+ *     logger.log(`onTranscodingStarted { errCode:${errCode} errMsg:${errMsg}`);
+ *   });
+ *   localMediaTranscoder.on('onTranscodingStopped', (reason: number, reasonMsg: string) => {
+ *     logger.log(`onTranscodingStopped { reason:${reason} reasonMsg:${reasonMsg} }`);
+ *   });
+ *   // 监听摄像头事件
+ *   localMediaTranscoder.on('onCameraSourceStarted', (deviceId: string, errCode: number, errMsg: string) => {
+ *     logger.log(`onCameraSourceStarted { deviceId:${deviceId} errCode:${errCode} errMsg:${errMsg} }`);
+ *   });
+ *   localMediaTranscoder.on('onCameraSourceStopped', (deviceId: string, reasonMsg: string) => {
+ *     logger.log(`onCameraSourceStopped { deviceId:${deviceId} reasonMsg:${reasonMsg}}`);
+ *   });
+ *   // 监听屏幕、窗口分享事件
+ *   localMediaTranscoder.on('onScreenSourceStarted', (sourceId: string, errCode: number, errMsg: string) => {
+ *     logger.log(`onScreenSourceStarted { sourceId:${sourceId} errCode:${errCode} errMsg:${errMsg} }`);
+ *   });
+ *   localMediaTranscoder.on('onScreenSourceStopped', (sourceId: string, reason: number) => {
+ *     logger.log(`onScreenSourceStopped { sourceId:${sourceId}, reason:${reason} }`);
+ *   });
+ *
+ *   // 开启摄像头一
+ *   localMediaTranscoder.startCameraSource(
+ *     cameraList[0].deviceId,
+ *     {
+ *       mode: TRTCCameraCaptureMode.CameraResolutionStrategyAuto,
+ *       width: 640,
+ *       height: 360,
+ *     },
+ *     {
+ *       rotation: TRTCVideoRotation.TRTCVideoRotation0,
+ *       fillMode: TRTCVideoFillMode.TRTCVideoFillMode_Fit,
+ *       mirrorType: TRTCVideoMirrorType.TRTCVideoMirrorType_Disable,
+ *     }
+ *   );
+ *
+ *   // 开启摄像头二
+ *   localMediaTranscoder.startCameraSource(
+ *     cameraList[1].deviceId,
+ *     {
+ *         mode: TRTCCameraCaptureMode.CameraResolutionStrategyAuto,
+ *         width: 640,
+ *         height: 360
+ *     },
+ *     {
+ *         rotation: TRTCVideoRotation.TRTCVideoRotation0,
+ *         fillMode: TRTCVideoFillMode.TRTCVideoFillMode_Fit,
+ *         mirrorType: TRTCVideoMirrorType.TRTCVideoMirrorType_Disable
+ *     }
+ *   );
+ *
+ *   // 开启屏幕一
+ *   localMediaTranscoder.startScreenSource(screenSourceList[0], {top:10, left:10, right:1200, bottom:800});
+ *
+ *   // 开启屏幕二
+ *   localMediaTranscoder.startScreenSource(screenSourceList[1], {top:0, left:0, right:0, bottom:0});
+ *
+ *   // 启动合图转码并推流
+ *   localMediaTranscoder.startTranscoding(
+ *     TRTCVideoStreamType.TRTCVideoStreamTypeBig,
+ *     {
+ *       inputSourceList: [
+ *         { // camera 1
+ *           sourceType: TRTCLocalMediaTranscodingSourceType.MediaSourceCamera,
+ *           cameraDeviceId: cameraList[0].deviceId,
+ *           rect: { left: 0, top: 0, right: 320, bottom: 180 },
+ *           zOrder: 1,
+ *           mirror: false,
+ *         },
+ *         { // camera 2
+ *           sourceType: TRTCLocalMediaTranscodingSourceType.MediaSourceCamera,
+ *           cameraDeviceId: cameraList[1].deviceId,
+ *           rect: {left: 320 + 20, top: 180 + 20, right: 640 + 20, bottom: 360 + 20},
+ *           zOrder: 2,
+ *           mirror: false
+ *         },
+ *         {
+ *           // screen 1
+ *           sourceType: TRTCLocalMediaTranscodingSourceType.MediaSourceScreen,
+ *           screenSourceId: screenSourceList[0].sourceId,
+ *           rect: {left: 320 + 20, top: 0, right: 640 + 20, bottom: 180},
+ *           zOrder: 3,
+ *           mirror: false
+ *         },
+ *         {
+ *           // screen 2
+ *           sourceType: TRTCLocalMediaTranscodingSourceType.MediaSourceScreen,
+ *           screenSourceId: screenSourceList[1].sourceId,
+ *           rect: {left: 0, top: 180 + 20, right: 320, bottom: 360 + 20},
+ *           zOrder: 4,
+ *           mirror: false
+ *         },
+ *       ],
+ *       videoEncoderParams: {
+ *         videoResolution: TRTCVideoResolution.TRTCVideoResolution_960_720,
+ *         resMode: TRTCVideoResolutionMode.TRTCVideoResolutionModeLandscape,
+ *         videoFps: 30,
+ *         videoBitrate: 800,
+ *         minVideoBitrate: 0,
+ *         enableAdjustRes: false,
+ *       },
+ *       canvasColor: 0xff0000, // 0x61b9f1,
+ *     }
+ *   );
+ *
+ *   // 设置本地预览
+ *   const view = document.getElementById("preview-view");
+ *   localMediaTranscoder.setMixedVideoRenderView(view as HTMLElement);
+ */
+declare class TRTCLocalMediaTranscoder extends EventEmitter {
+    private nativeLocalMediaTranscoder;
+    private renderer;
+    private container;
+    private pixelFormat;
+    constructor(nativeLocalMediaTranscoder: any, pixelFormat?: TRTCVideoPixelFormat);
+    destroy(): void;
+    /**
+     * 启动本地混流转码
+     *
+     * @param streamType {TRTCVideoStreamType} - 指定使用 TRTC 的 TRTCVideoStreamTypeBig 来推流，还是 TRTCVideoStreamTypeSub 来推流。
+     * @param params {TRTCLocalMediaTranscodingParams} - 指定本地混流转码的参数
+     * @param params.inputSourceList {TRTCLocalMediaTranscodingSource} - 【字段含义】指定转码流中的每一路输入媒体源配置的信息。
+     *  -【推荐取值】该字段是一个 TRTCLocalMediaTranscodingSource  类型的数组，数组中的每一个元素都用来代表每一路输入媒体源的信息。
+     *  -【特别说明】媒体源信息不支持留空，否则 TRTCLocalMediaoTranscodingCallback.onTranscodingStarted 会报错。
+     * @param params.videoEncoderParams {TRTCVideoEncParam} -【字段含义】转码流的视频编码参数
+     * @param params.canvasColor {Number} - 【字段含义】指定混合画面的底色。
+     *  -【推荐取值】默认值：0x000000 代表黑色。格式为十六进制数字，比如：“0x61B9F1” 代表 RGB 分别为（97、158、241）。
+     */
+    startTranscoding(streamType: TRTCVideoStreamType, params: TRTCLocalMediaTranscodingParams): void;
+    /**
+     * 更新本地混流转码参数
+     *
+     * @param params {TRTCLocalMediaTranscodingParams} - 指定本地混流转码的参数
+     */
+    updateTranscodingParams(params: TRTCLocalMediaTranscodingParams): void;
+    /**
+     *  停止本地混流转码
+     */
+    stopTranscoding(): void;
+    /**
+     * 启动摄像头采集
+     *
+     * @param deviceId {String} - 摄像头设备 Id
+     * @param transcodeParams {TRTCCameraCaptureParams} - 指定摄像头采集分辨率和帧率
+     * @param renderParams {TRTCRenderParams} - 指定摄像头数据源是否旋转、镜像和填充模式
+     */
+    startCameraSource(deviceId: string, transcodeParams: TRTCCameraCaptureParams, renderParams: TRTCRenderParams): void;
+    /**
+     * 停止摄像头采集
+     * @param deviceId {String} - 摄像头设备 Id
+     */
+    stopCameraSource(deviceId: string): void;
+    /**
+     * 启动屏幕/窗口采集
+     *
+     * @param source {TRTCScreenCaptureSourceInfo} - 屏幕/窗口采集的详细参数
+     * @param rect {Rect} - 指定捕获的区域
+     */
+    startScreenSource(source: TRTCScreenCaptureSourceInfo, rect: Rect): void;
+    /**
+     * 停止屏幕/窗口采集
+     * @param sourceId {String} - 屏幕/窗口的 Id
+     */
+    stopScreenSource(sourceId: string): void;
+    /**
+     * 启动图片采集
+     * @param path {String} - 图片路径 ，目前只支持 BMP、JPG、PNG、GIF 四种格式
+     * @param fps {Number} - 采集输出帧率，可以不设置由 SDK 做最佳决策
+     */
+    addImageSource(path: string, fps: number): void;
+    /**
+     * 停止图片采集
+     * @param path {String} - 图片路径
+     */
+    removeImageSource(path: string): void;
+    /**
+     * 设置本地混流转码视频预览节点
+     * @param el {HTMLElement} - 必须是 HTML 块元素
+     */
+    setMixedVideoRenderView(el: HTMLElement): void;
+    private setMixedVideoFrameRenderCallback;
+    private setEventCallback;
+    private renderMixedVideoFrame;
+}
+export default TRTCLocalMediaTranscoder;