armcloud-rtc 1.0.0

package/dist/types/lib/webRtc.d.ts

@@ -0,0 +1,178 @@
+import type { CustomDefinition } from "./type";
+declare class WebRTC {
+    private initDomId;
+    private initDomWidth;
+    private initDomHeight;
+    private videoDomId;
+    private remoteVideoContainerId;
+    private remoteVideoId;
+    private remoteAudioStream;
+    private remoteVideoStream;
+    private hasPushDown;
+    private refreshUiMsgNumber;
+    private getFirstFrame;
+    private errorInfo;
+    private remoteResolution;
+    private roomMessage;
+    private options;
+    private socket;
+    private retryCount;
+    private retryCountBackup;
+    private retryTime;
+    private remotePc;
+    private dataChannel;
+    private remoteUserId;
+    private inputElement;
+    autoRecoveryTimer: any;
+    runInfoTimer: any;
+    private touchConfig;
+    /**
+     * 安卓对应回车值
+     * go：前往 2
+     * search：搜索 3
+     * send：发送 4
+     * next：下一个 5
+     * done：完成 6
+     * previous：上一个 7
+     */
+    enterkeyhintObj: {
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+    };
+    private socketParams;
+    callbacks: any;
+    audioStream: any;
+    audioSender: any;
+    logTime: any;
+    constructor(viewId: string, params: any, callbacks: any, logTime: any);
+    setLogTime(key: any): void;
+    sendEventReport(operation: any): void;
+    getMsgTemplate(touchType: string, content: object): string;
+    /** 获取应用信息 */
+    getEquipmentInfo(type: "app" | "attr"): void;
+    /** 应用卸载 */
+    appUnInstall(pkgNames: Array<string>): void;
+    addReportInfo(info: any): void;
+    /**
+     * AES 解密方法
+     * @param {*} encryptData 加密数据
+     * @param {*} key 秘钥
+     * @returns 解密后数据
+     */
+    decryptAES(encryptData: string, key: string): any;
+    pauseAudioMedia(): void;
+    captureAndSendAudio(): Promise<void>;
+    /** 初始化ws */
+    initWebSocket(): void;
+    startPlay(): void;
+    /** 加入房间 */
+    start(): void;
+    /** 发送offer */
+    sendOffer(): Promise<void>;
+    /** 接收webrtc offer */
+    receiveOffer(offer: any): Promise<void>;
+    /** 接收webrtc answer */
+    receiveAnswer(answer: any): Promise<void>;
+    /** 发送webrtc answer */
+    sendAnswer(): Promise<void>;
+    isFirstFrameSuccess(): boolean;
+    /**
+     * 控制轨道声音
+     * @param streams
+     * @param status
+     */
+    controlTrackVoice(streams: any, type?: string, status?: boolean): void;
+    /** 第一帧加载完成 */
+    renderedFirstFrame(): void;
+    /** 等待视频首帧画面被渲染 */
+    waitForFirstFrameRendered(video: any): void;
+    /** 销毁引擎 */
+    destroyEngine(): void;
+    stop(describe: any): void;
+    /** 定期获取统计信息的函数 */
+    getStats(): Promise<void>;
+    /** 浏览器是否支持 */
+    isSupported(): boolean;
+    /** 触发无操作回收回调函数 */
+    triggerRecoveryTimeCallback(): void;
+    /** 发送消息 */
+    sendUserMessage(message: string): Promise<void>;
+    /** 监听广播消息 */
+    onRoomMessageReceived(): void;
+    /**
+     * 将字符串发送到云手机的粘贴板中
+     * @param inputStr 需要发送的字符串
+     */
+    sendInputClipper(inputStr: string): Promise<void>;
+    /**
+     * 当云手机处于输入状态时，将字符串直接发送到云手机，完成输入
+     * @param inputStr 需要发送的字符串
+     */
+    sendInputString(inputStr: string): Promise<void>;
+    /**
+     * 发送摇一摇信息
+     */
+    sendShakeInfo(time: any): void;
+    /** 清晰度切换 */
+    setStreamConfig(config: CustomDefinition): void;
+    handleSendData(options: any): string;
+    /**
+     * 暂停接收来自远端的媒体流
+     * 该方法仅暂停远端流的接收，并不影响远端流的采集和发送。
+     * @param mediaType 1 只控制音频; 2 只控制视频; 3 同时控制音频和视频
+     */
+    pauseAllSubscribedStream(mediaType?: number): void;
+    /**
+     * 恢复接收来自远端的媒体流
+     * 该方法仅恢复远端流的接收，并不影响远端流的采集和发送。
+     * @param mediaType 1 只控制音频; 2 只控制视频; 3 同时控制音频和视频
+     */
+    resumeAllSubscribedStream(mediaType?: number): void;
+    /** 截图-保存到本地 */
+    saveScreenShotToLocal(): Promise<unknown>;
+    /** 截图-保存到云机 */
+    saveScreenShotToRemote(): void;
+    /**
+     * 手动横竖屏
+     * 对标百度API
+     */
+    setPhoneRotation(type: number): void;
+    rotateScreen(degree: number): void;
+    /** 手动定位 */
+    setGPS(longitude: number, latitude: number): void;
+    /** 云机/本地键盘切换(false-云机键盘，true-本地键盘) */
+    setKeyboardStyle(keyBoardType: string): void;
+    /** 查询输入状态 */
+    onCheckInputState(): Promise<void>;
+    /** 添加input输入框 */
+    addInputElement(): void;
+    /**
+     * 设置无操作回收时间
+     * @param second 秒 默认300s,最大7200s
+     */
+    setAutoRecycleTime(second: number): void;
+    /** 获取无操作回收时间 */
+    getAutoRecycleTime(): any;
+    /** 底部栏操作按键 */
+    sendCommand(command: string): void;
+    /** 返回按键事件 */
+    goAppUpPage(): void;
+    /** 主页按键事件 */
+    goAppHome(): void;
+    /** 菜单按键事件 */
+    goAppMenu(): void;
+    /** 音量增加按键事件 */
+    increaseVolume(): void;
+    /** 音量减少按键事件 */
+    decreaseVolume(): void;
+    /**
+     * 是否接收粘贴板内容回调
+     * @param flag true:接收 false:不接收
+     */
+    saveCloudClipboard(flag: boolean): void;
+}
+export default WebRTC;

package/dist/types/types/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 火山云RTC初始化参数
+ * @param appId
+ * @param roomCode rtc房间code
+ * @param roomToken rtc房间token
+ * @param clientId 远程云机id
+ * @param userId 用户id
+ * @param expirationTime 无操作回收时间 秒
+ * @param selfAdaption 渲染模式 1：自适应屏幕 2：填充屏幕
+ * @param mediaType 媒体流类型，1：只控制音频 2：只控制视频 3：同时控制音频和视频
+ * @param rotateType 旋转屏幕 type 1：横屏；2：竖屏
+ * @param definition 设置清晰度 1：标清 2：高清 3：超清
+ * @param useLocalKeyboard 是否启用本地输入法
+ * @param allowCopyRemoteToLocal 允许云机复制到真机
+ */
+export interface CloudCoreConfig {
+    appId: string;
+    roomCode: string;
+    roomToken: string;
+    clientId: string;
+    userId: string;
+    expirationTime?: number;
+    selfAdaption?: string | number;
+    mediaType?: string | number;
+    rotateType?: number;
+    definition?: string | number;
+    useLocalKeyboard?: boolean;
+    allowCopyRemoteToLocal?: boolean;
+}
+/**
+ * 手指触摸配置参数
+ * @action 0 按下 1 抬起 2 触摸中
+ * @widthPixels 画布宽度
+ * @heightPixels 画布高度
+ * @pointCount 操作手指数量
+ * @touchType touchType: 'gesture'写死
+ * @properties 同时操控手指数组 手指id: 自定义；toolType: 1写死
+ * @coords 操作坐标 pressure: 1.0, size: 1.0,写死 x: x坐标；y：y坐标
+ */
+interface PropertiesInfo {
+    id: number;
+    toolType: number;
+}
+interface CoordsInfo {
+    mPackedAxisValues?: any;
+    pressure: number;
+    size: number;
+    x: number;
+    y: number;
+}
+export interface TouchConfig {
+    action: number | string;
+    widthPixels: number;
+    heightPixels: number;
+    pointCount: number;
+    touchType: string;
+    properties: PropertiesInfo[];
+    coords: CoordsInfo[];
+}
+/**
+ * 自定义清晰度
+ * @definitionId 分辨率 7：144*256；8：216*384；9：288*512；10：360*640；11：480*848；12：540*960；13：600*1024；14：480*1280；15：720*1280；16：720*1920；17：1080*1920；18：1440*1920；19：1600*2560；20：2880*1080
+ * @framerateId 帧率 1：20fps；2：25fps；3：30fps；4：60fps；5：1fps；6：5fps；7：10fps；8：15fps；9：2fps
+ * @bitrateId 码率 1：1Mbps；2：1.5Mbps；3：2Mbps；4：2.5Mbps；5：3Mbps；6：3.5Mbps；7：4Mbps；8：5Mbps；9：6Mbps；10：8Mbps；11：10Mbps；12：12Mbps；13：200kbps；14：400kbps；15：600kbps
+ */
+export interface CustomDefinition {
+    definitionId: number | null;
+    framerateId: number | null;
+    bitrateId: number | null;
+}
+/**
+ * 定位信息
+ * @accuracy 精度
+ * @altitude 海拔高度
+ * @latitude 纬度
+ * @longitude 经度
+ * @speed 速度
+ * @time 时间
+ */
+export interface PositionOption {
+    accuracy?: number | null;
+    altitude?: number | null;
+    latitude: number | null;
+    longitude: number | null;
+    speed?: number | null;
+    time?: number | null;
+}
+export {};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "armcloud-rtc",
+  "version": "1.0.0",
+  "main": "dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "build": "rollup --config rollup.config.ts --configPlugin typescript"
+  },
+  "author": "ask",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "@volcengine/rtc": "^4.61.2",
+    "axios": "^1.7.3",
+    "crypto-js": "^4.2.0",
+    "webrtc-adapter": "^9.0.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@babel/preset-env": "^7.25.3",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "tslib": "^2.6.3"
+  }
+}