快速接入

// 所有服务的 iceConfig 配置一致
const iceConfig = [
 {
 urls: `turn:${url}:3478`, // 默认端口 3478
 username: "coturn", // 默认用户 coturn
 credential: "123456", // 默认凭据 123456
 },
];
// 云游戏服务信令地址
const signaling = `wss://${address}/clientWebsocket/${token}`;
// 云手机信令地址
const signaling = `wss://${address}/signaling/client/${token}`;

// 如果启动的是 Windows 应用
const launcher = new Launcher(signaling, iceConfig, hostElement);
// 如果启动的是 Android 应用
const launcher = new MobileLauncher(signaling, iceConfig, hostElement);

功能与方法

Windows 应用独有功能

虚拟键盘

// 开启
launcher.showKeyboard();
// 关闭
launcher.hideKeyboard();

IME 键盘(手机默认输入法)

// 唤起
launcher.wakeOnIME();

虚拟摇杆

// 开启
launcher.showJoyStick();
// 关闭
launcher.hideJoyStick();

切换触控板模式

默认(不开启)

触控(direct 模式)

拖动(relative 模式)

// 启用拖动模式
launcher.enableTrackpad("relative");
// 启用触控模式
launcher.enableTrackpad("direct");
// 禁用触控板
launcher.disableTrackpad();

自定义虚拟控件布局

// 这里作为演示只创建了一个 S 按键
const layout = [
 {
 xPercent: 0.11299435028248588,
 yPercent: 0.6782128514056225,
 widthPercent: 0.1,
 heightPercent: 0.17771084337349397,
 codes: 83,
 showName: "",
 schemeKeys: "S",
 aspectRatio: 1,
 srcList: [],
 type: 0,
 opacity: 1,
 anchor: "screen",
 },
];
// 创建一个虚拟控件布局,返回值为该布局的唯一标识
const id = launcher.createOnScreenControlsProfile("control_name", layout);
// 显示指定 id 的虚拟控件布局,参数可选,不传默认显示第一个
launcher.showOnScreenControlsByProfileId(id);
// 关闭
launcher.hideOnScreenControls();

文件上传

// file 为浏览器 File 对象
launcher.uploadFile(file, (e) => {
 if (e.state === "progress") {
 // 发送进度 [0-100]
 console.log(e.progress);
 } else if (e.state === "error") {
 // 远端拒绝接或者发送错误
 console.error(e.reason);
 } else if (e.state === "done") {
 console.log("done");
 }
});

变更编码器设定

// 修改推流端编码器的设置
launcher.changeCodecOptions({
 bitrate: 3000, // 码率
 framerate: 30, // 帧率
 gopLength: 250, // I 帧间隔
});
// 如果只需改变码率
launcher.changeCodecOptions({ bitrate: 3000 });

变更分辨率

// 修改分辨率为 HD
launcher.changeResolution(1280, 720);

Android 应用独有功能

发送手机功能键

const MobileKeysKeycode {
 KeycodeHome: 3, // Home 键
 KeycodeBack: 4, // 返回键
 KeycodeVoiceUp: 24, // 音量 + 键
 KeycodeVoiceDown: 25, // 音量 - 键
 KeycodeAppSwitch: 187, // 应用切换键
}
const MobileKeysActionType {
 ActionDown: 0, // 按下
 ActionUp: 1, // 抬起
}
// 发送一次 Home 键单击
launcher.sendMobileAction(MobileKeysKeycode.KeycodeHome, MobileKeysActionType.ActionDown);
launcher.sendMobileAction(MobileKeysKeycode.KeycodeHome, MobileKeysActionType.ActionUp);

变更码率

// 单位 kbps
launcher.connection.changeBandwidthByRenegotiation(1500);

变更分辨率比例

// 范围 [0-1]
launcher.connection.changeMobileResolutionScale(0.5);

通用功能

放大镜

// 开启
launcher.showMagnifier();
// 关闭
launcher.hideMagnifier();

获取统计信息

// 开关统计信息
launcher.toggleStatistics();
// 开启后可以通过以下方法获得统计数据
window.setInterval(() => {
 const { rtt, fps, bitrate, packetLossRate, latency } = launcher.report();
 console.log(`
 FPS: ${fps}
 rtt: ${rtt}ms
 latency: ${latency}ms
 biterate: ${bitrate}kbps
 packetLossRate: ${(packetLossRate * 100).toFixed(3)}%
 `);
}, 1000);

导出日志

launcher.exportLog();

销毁

launcher.destory();

实例化参数说明

// Windows 应用
new Launcher(url, iceServers, hostElement[, options])
// Android 应用
new MobileLauncher(url, iceServers, hostElement[, options])

必填参数说明

可选参数 options 包含字段及其说明

Launcher 独有的可选参数

Phase 说明

事件

建议兼容性使用

桌面端

移动端