# @genymotion/device-web-player 中文文档

规范地址：https://npmcn.com/package/%40genymotion/device-web-player/

版本：4\.3\.2
npm 元数据更新时间：2026-11-03T08:33:21.296Z
中文译文更新时间：2026-11-16T04:06:07.805Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40genymotion/device-web-player
原文对照：https://npmcn.com/package/%40genymotion/device-web-player/?lang=original
项目主页：https://github.com/Genymobile/genymotion-device-web-player#readme
源码仓库：https://github.com/Genymobile/genymotion-device-web-player

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：793 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2021-10-18T18:49:37.313Z
- 最新版本发布：2026-11-03T08:33:20.992Z
- 近 30 天下载量：18959（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 2 个）

## 中文简介

Genymotion 虚拟设备网络渲染器

## 安装

```sh
npm install @genymotion/device-web-player
```

也可以使用：`pnpm add @genymotion/device-web-player`、`yarn add @genymotion/device-web-player`、`bun add @genymotion/device-web-player`

## README

# Genymotion 设备网络渲染器

![npm](https://img.shields.io/npm/v/@genymotion/device-web-player) ![GitHub](https://img.shields.io/github/license/Genymobile/genymotion-device-web-player)

[![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/screenshot.png)](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/screenshot.png)

这个寄存器包含了Genymotion设备网络渲染器JavaScript SDK. 它提供了一种容易融合的方法 **热能装置** 在云中运行到任何网络应用程序。 您可以显示一个模拟屏幕并与设备交互 .

### 电力工程师

-   **兼容性** (vanilla JavaScript, 没有使用外部框架)
-   **业绩** (30英尺或以上)
-   **质量** (截至1920×1080) (中文(简体) )
-   **低纬度**

关于Genymotion设备的更多信息,请访问 [基因运动网站](https://www.genymotion.com/)。 。 。 .

## 目录

1.  📋 [所需资源](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%93%8B-requirements)
2.  📦 [安装](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%93%A6-installation)
    1.  📥 [通过国家预防机制/亚恩安装](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%93%A5-install-via-npm--yarn)
    2.  🌐 [通过 CDN 安装](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%8C%90-install-via-a-cdn)
3.  ⚡ [快速启动指南](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%E2%9A%A1-quick-start-guide)
4.  🎨 [样式和CSS](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%8E%A8-style-and-css)
5.  📘 [API 文档](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%93%98-api-documentation)
    1.  📡 [VM 通讯](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%93%A1-vm_communication)
    2.  🛠️ [倾斜](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%9B%A0%EF%B8%8F-utils)
    3.  🎮 [密钥映射](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%8E%AE-keyMapping)
    4.  🔊 [媒体](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%94%8A-media)
    5.  🎥 [视频](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%8E%A5-video)
6.  ⚙️ [特性选项( E)](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%E2%9A%99%EF%B8%8F-features--instance-options)
    1.  🖥️ [实例选项](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%96%A5%EF%B8%8F-instance-options)
    2.  🔌 [插件选项](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%94%8C-plugin-options)
7.  ❓ [财务问题](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%E2%9D%93-faq)
8.  🤝 [捐款](https://npmcn.com/package/%40genymotion/device-web-player/#readme-%F0%9F%A4%9D-contributing)

## 所需经费

一个现代的,WebRTC相容的,Web浏览器:

-   Google Chrome 85+ (英语)
-   Mozilla Firefox 78+ (英语)
-   歌剧70+
-   微软边缘 20.10240+
-   萨法里11+

## \* 安装

### 通过国家预防机制/亚恩安装

**需要20号或以后的节点.**

使用线条 :

```bash
yarn add @genymotion/device-web-player
```

使用 npm :

```bash
npm install @genymotion/device-web-player
```

软件包导入( commonJS ) :

```js
const {DeviceRendererFactory} = require('@genymotion/device-web-player');
```

```html
<style lang="scss">
    @import '@genymotion/device-web-player/dist/css/device-renderer.min.css';
</style>
```

### 通过 CDN 安装

```html
<link
    rel="stylesheet"
    href="https://cdn.jsdelivr.net/npm/@genymotion/device-web-player@4.3.2/dist/css/device-renderer.min.css"
/>
<script src="https://cdn.jsdelivr.net/npm/@genymotion/device-web-player@4.3.2/dist/js/device-renderer.min.js"></script>
```

## QQ 快速启动指南

使用 `DeviceRendererFactory` 要对一个或多个设备渲染器进行即时化处理,您只需要一个HTML元素作为容器和一个有效的符号.

去找你的机会 **WebRTC 地址**,使用 [萨斯API](https://developer.genymotion.com/saas/#operation/getInstance) 或检查 [PaaS 文档](https://docs.genymotion.com/paas/01_Requirements/),基于您的设备提供者.

参看下文的例子或探索我们 [详细实例](https://github.com/Genymobile/genymotion-device-web-player/tree/main/example)

**说明:** 如果不定义容器元素高度, 设备屏幕可能不会显示 。 使用 CSS 设置有意义的高度( 例如 ), `height: 100vh`) (中文(简体) ).

```html
<!-- OPTIONAL: Import google maps library with your API key to enable map positioning feature.
     The Player supports both Classical (script tag) and Dynamic (importLibrary) loading methods.
<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY" async defer></script>
-->

<div id="genymotion"></div>

<script>
    // Instance address
    const webrtcAddress = 'wss://x.x.x.x';
    const container = document.getElementById('genymotion');

    // See "Features & options" section for more details about options
    const options = {
        token: 'XXXXXXXXXX', // token is the shared secret to connect to your VM
        fileUpload: false, // requires fileUploadUrl
    };

    // Device renderer instanciation
    const {DeviceRendererFactory} = window.genyDeviceWebPlayer;
    const deviceRendererFactory = new DeviceRendererFactory();
    const rendererAPI = deviceRendererFactory.setupRenderer(
        container, // the container element or element ID to use
        webrtcAddress, // the websocket address of your instance connector
        options, // options object to enable or disable features
    );

    // Disconnect the device renderer, closing any open data channels.
    window.addEventListener('beforeunload', function () {
        rendererAPI.VM_communication.disconnect();
    });
</script>
```

### {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}说说信物

对于 SaaS ,玩家需要一个实例扫描访问符 (`access_token`)——不是用户JWT. 每个 SaaS API 请求精确使用一个认证方案 :

-   `Authorization: Bearer <JWT>` 登录后通过 `POST /v1/users/login`,或
-   `x-api-token: <API_TOKEN>` 使用来自SaaS门户网站的API令牌.

不同时发送两个信头 .

生成 SaaS 设备的流程 :

1.  认证其中任何一个方案(不是两个方案):

-   JWT: 华为: `POST /v1/users/login` \* 答复载有 `token` (你的JWT) (中文(简体) ).
-   API 令牌: 跳过登录和使用 `x-api-token` 直接说.

2.  获取实例信息 `webrtcAddress`: `GET /v1/instances/<INSTANCE_UUID>` 使用您所选的标题 .
3.  生成 per- intance 访问符 : `POST /v1/instances/access-token` 与身体 `{"instance_uuid":"<INSTANCE_UUID>"}` 使用相同的标题.
4.  使用返回的内容 `access_token` 作为 `options.token` 调用时 `setupRenderer`。 。 。 .

注释:

-   SaaS JWTs在一段时间后失效(例如~48h). 必要时通过再登录再生成.
-   这个 `access_token` 范围为单一实例,并可能过期;如果收到无效/已过期的符号错误,请再次拨打访问端点并重新连接.
-   对于 Genymotion 设备图像, `options.token` 您的云提供方提供的示例ID 。 不需要SaaS API电话.

有用的参考文献 :

-   登录(JWT):https://developer.genymotion.com/saas/#operation/login 互联网档案馆的存檔,存档日期2013-12-20
-   获取实例:https://developer.genymotion.com/saas/#operation/getInstance
-   访问令牌:https://developer.genymotion.com/saas/#tag/Instances-v1/operation/accessToken
-   API 令牌概览 : [https://www.genymotion.com/blog/api-tokens-for-genymotion-saas/ (中文(简体) )](https://www.genymotion.com/blog/api-tokens-for-genymotion-saas/)

### SaaS 键流实例

这里有一些实例可以用来检索 `access_token`。 。 。 .

#### 使用 `curl`

这可用于后端脚本或测试.

```bash
# 1. (Optional) Login to get a JWT if you are not using an API Token
JWT=$(curl -X POST https://api.geny.io/cloud/v1/users/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.com","password":"<your_password>"}' | jq -r .token)

# 2. Get instance details (like webrtcAddress)
# Using a JWT
curl https://api.geny.io/cloud/v1/instances/<INSTANCE_UUID> \
  -H "Authorization: Bearer $JWT"

# Or using an API Token
curl https://api.geny.io/cloud/v1/instances/<INSTANCE_UUID> \
  -H "x-api-token: <YOUR_API_TOKEN>"

# 3. Generate the access_token for the player
# Using a JWT
ACCESS_TOKEN=$(curl -X POST https://api.geny.io/cloud/v1/instances/access-token \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $JWT" \
  -d '{"instance_uuid":"<INSTANCE_UUID>"}' | jq -r .access_token)

# Or using an API Token
ACCESS_TOKEN=$(curl -X POST https://api.geny.io/cloud/v1/instances/access-token \
  -H 'Content-Type: application/json' \
  -H "x-api-token: <YOUR_API_TOKEN>" \
  -d '{"instance_uuid":"<INSTANCE_UUID>"}' | jq -r .access_token)

echo "Your access token is: $ACCESS_TOKEN"
```

#### 使用 Java 脚本 `fetch`

这就是您如何在前端应用程序中执行它 .

```javascript
async function getSaasAccessToken(instanceUuid, apiToken) {
    try {
        const response = await fetch('https://api.geny.io/cloud/v1/instances/access-token', {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'x-api-token': apiToken, // or 'Authorization': 'Bearer <JWT>'
            },
            body: JSON.stringify({ instance_uuid: instanceUuid }),
        });

        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }

        const data = await response.json();
        return data.access_token;
    } catch (error) {
        console.error('Failed to get SaaS access token:', error);
        return null;
    }
}

// Usage:
const instanceUuid = '<YOUR_INSTANCE_UUID>';
const apiToken = '<YOUR_API_TOKEN>'; // Or use a JWT
getSaasAccessToken(instanceUuid, apiToken).then(accessToken => {
    if (accessToken) {
        // Now use this accessToken in the player options
        const options = {
            token: accessToken,
            // ... other options
        };
        // ... setupRenderer ...
    }
});
```

### Token 解决问题

如果玩家无法连接, 请检查这些常见的 WebSocket 关闭代码 :

-   **第4242条**: 符号无效或错误。 校验您正在使用 `access_token` 对于SaaS,不是一个JWT.
-   **4243 (英语)**: 该符已过期. 重生成一个新的 `access_token` 使用 `/v1/instances/access-token` 结束点和重新连接.
-   如果您从 SaaS API 中获取到 HTTP 400/401 错误, 请确保您使用一个精确的认证头( S) `Authorization` 或者说 `x-api-token`),而非两者兼有.

## \* 样式和CSS

玩家利用材料设计模式中的CSS变量来给应用程序作样式,同时通过压倒CSS类保持完全自定义.

#### CSS 变量及其默认预设可用 :

颜色

```
--gm-primary-color: rgba(230, 25, 94, 1);
--gm-on-primary-color: rgba(255, 255, 255, 1);
--gm-primary-variant-color: rgba(230, 25, 94, 0.2);
--gm-on-primary-variant-color: rgba(230, 25, 94, 1);
--gm-secondary-color: #292929;
--gm-on-secondary-color: #ffffff;
--gm-secondary-variant-color: #212121;
--gm-on-secondary-variant-color: #ffffff;
--gm-tertiary-color: #c4c4c44d;
--gm-on-tertiary-color: #ffffff;
--gm-tertiary-variant-color: #c4c4c4;
--gm-on-tertiary-variant-color: #1A1A1A;
--gm-background-color: #1A1A1A;
--gm-on-background-color: #ffffff;
--gm-surface-color: #292929;
--gm-on-surface-color: #ffffff;
--gm-error-color: rgba(255, 17, 17, 1);
--gm-background-error-color: rgba(255, 17, 17, 0.1);
--gm-success-color: rgba(17, 185, 32, 1);
--gm-background-success-color: rgba(17, 185, 32, 0.1);
--gm-warning-color: rgba(255, 204, 0, 1);
--gm-background-warning-color:  rgba(255, 204, 0, 0.1);
--gm-gradiant-1: linear-gradient(142.33deg, #E6195E 4.58%, #2B41EA 122.31%);
--gm-on-gradiant-1: rgba(255, 255, 255, 1);
--gm-gradiant-2: linear-gradient(275.69deg, #E6195E 10.31%, #2B41EA 136.09%);
--gm-on-gradiant-2: rgba(255, 255, 255, 1);
```

## API 文档

Player API提供了管理插件选项和websocket通信的功能. 操作是通过 API (分类) 对象处理的 `setupRenderer` 函数.

### 📡 `VM_communication`

#### `disconnect`

**说明**:将玩家从虚拟机(VM)中断开,并清理内存听众.

#### `addEventListener`

**说明**: 为 VM 发布的消息注册一个收听器.

-   **参数**数字 :
    
    -   `event` (字符串):要聆听的事件名称(例如"指印","gps").
    -   `callback` (职务): 事件发射时调用函数 。 VM的留言将传递给回电.
-   **示例用途**数字 :
    
    ```js
    addEventListener('fingerprint', (msg) => {
        console.log(msg);
    });
    ```
    

#### `sendData`

**说明**: 向VM发送消息.

-   **参数**数字 :
    
    -   `data` (对象): 包含要发送的频道和信件的对象 .
        -   `channel` (字符串):发送消息的通道.
        -   `messages` (阵列<弦>): 要发送的一系列信件 .
-   **示例用途**数字 :
    
    ```js
    sendData({
        channel: 'battery',
        messages: ['set state level 10', 'set state status true'],
    });
    ```
    

### 🛠️ `utils`

#### `getRegisteredFunctions`

**说明**: 返回带有可选描述的现有函数列表.

### 🎮 `keyMapping`

#### `setConfig`

**说明**: 提供密钥映射配置. 配置作为包含密钥值对的对象传递

-   **示例配置**数字 :
    
    ```js
    {
        dPad: [{
            keys: [
                {
                    key: 'w',
                    effect: { initialX: 20, initialY: 80, distanceX: 0, distanceY: -10 },
                    name: 'up',
                    description: 'move up',
                },
                {
                    key: 's',
                    effect: { initialX: 20, initialY: 80, distanceX: 0, distanceY: 10 },
                    name: 'down',
                    description: 'move down',
                },
                // ... other keys
            ],
            name: 'character movement',
            description: 'Left joystick used to move the character',
        }],
        tap: [{
            key: 'p',
            effect: { initialX: 50, initialY: 50 },
            name: 'Fire',
        }],
        swipe: [{
            key: 'u',
            effect: { initialX: 50, initialY: 50, distanceX: -10, distanceY: 0, description: 'swipe left' },
            name: 'Left dodge',
            description: 'Dodge on the left',
        }]
    }
    ```
    

#### `activeKeyMappingDebug`

**说明**:帮助创建配置映射.

-   **参数**数字 :
    -   `isTraceActivate` (布尔语): 如果选中的话, 它会在视频流上打印 x 和 y 坐标, 供所有点击 .
    -   `isGridActivate` (布尔语): 如果为真,请在视频流上显示网格 。 两行和一行的大小都为10%.

#### `enable`

**说明**: 启用或禁用密钥映射 .

-   **参数**数字 :
    -   `isActive` (布尔,可选): 启用或禁用密钥映射 。 默认是虚假的.

### 🔊 `media`

#### `mute`

**说明**: 监听玩家的音频.

#### `unmute`

**说明**:解除玩家的音频.

### 🎥 `video`

#### `fullscreen`

**说明**: 启用全屏模式,但必须按照浏览器安全规则从用户动作中调用.

### 🧩 `widget`

#### `openWidget`

**说明**: 程序打开部件.

-   **参数**数字 :
    -   `widgetName` (字符串): 部件的类名称, 与该部件所用的名称相同 **工具栏名称**。 。 。 .

#### `closeWidget`

**说明**: 程序关闭部件 .

-   **参数**数字 :
    -   `widgetName` (字符串): 部件的类名称, 与该部件所用的名称相同 **工具栏名称**。 。 。 .

## QQ 特性和实例选项

设备渲染器实例可以使用 `options` 参数(对象)。 下文介绍可能的配置密钥/值.

### 实例选项

#### `token`

-   **类型 :** `String`
-   **默认 :** `undefined`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 实例访问符,用于连接设备的共享秘密. 对于 Genymotion PaaS 设备, 符号是实例 id (可以找到更多信息) [这里](https://docs.genymotion.com/paas/02_Getting_Started/)) (中文(简体) ). 对于 SaaS 设备,您必须使用 [`/v1/instances/access-token` 结束点](https://developer.genymotion.com/saas/#tag/Instances-v1/operation/accessToken)。 。 。 .

#### `toolbarOrder`

-   **类型 :** `Array<string>`
-   **默认 :** `[]`
-   **特殊选项**
    -   `separator`: 显示图标之间的分隔符
    -   `unordered`: 显示所有其他活动但没有明确指定的插件图标 `toolbarOrder`
-   **示例**数字 :`[ 'ButtonsEvents_ROTATE', 'separator', 'Battery', 'FingerPrint', 'separator', 'unordered', 'separator', 'ButtonsEvents_POWER']`
-   **细节 :** 这个 `toolbarOrder` 选项允许您定义插件图标出现在工具栏中的顺序。 阵列中的每个字符串对应工具栏管理器中注册的按钮的独特标识符(id). 插件的ID在下面的插件选项细节中提供.

#### `showPhoneBorder`

-   **类型 :** `Boolean`
-   **默认 :** `false`
-   **细节 :** 在视频周围添加一个移动式的框架来模仿智能手机屏幕的外观.

### `toolbarPosition`

-   **类型 :** `String`
-   **默认 :** `right`
-   **细节 :** 工具栏的位置
-   **可用的选项 :**
-   `"left"` - 工具栏出现在左侧.
-   `"right"` • 工具栏出现在右侧.

### `floatingToolbar`

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **细节 :** 启用时,插件控件(如旋转,全屏,记录等)会在虚拟设备显示器下方的浮动工具栏中显示,工具栏只有在包含至少一个项目时才可见.

#### `mapId`

-   **类型 :** `String`
-   **默认 :** `'DEMO_MAP_ID'`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 谷歌地图ID. 在使用现代Google Maps API(Dynamic Library Introduction)启用GPS部件中的高级标记时,需要这样做. 如果不提供,则默认为 `'DEMO_MAP_ID'`,在生产中可能有限制或警告.

#### `connectionFailedURL`

-   **类型 :** `String`
-   **默认 :** `undefined`
-   **兼容性 :** `SaaS`, (中文(简体) ), `PaaS`
-   **细节 :** 出现连接错误时重定向页面 .

#### `giveFeedbackLink`

-   **类型 :** `String`
-   **默认 :** `giveFeedbackLink`
-   **兼容性 :** `SaaS`, (中文(简体) ), `PaaS`
-   **细节 :** 设置反馈页的url .

#### 高级选项

#### `i18n`

-   **类型 :** `Object`
-   **默认 :** `{}`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 翻译器UI的替代翻译.

#### `stun`

-   **类型 :** `Object`
-   **默认 :** `{}`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** WebRTC STUN服务器配置. 格式 :

```js
{
    urls: [
        'stun:stun-server1.org:80',
        'stun:stun-server2.org:443',
        ...
    ],
}
```

#### `turn`

-   **类型 :** `Object`
-   **默认 :** `{}`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** WebRTC TURN服务器配置. 格式 :

```js
{
    urls: [],
    username: "myUsername",
    credential: "myPassword",
    default: false  // Whether or not we should use the TURN servers by default. Default: false.
}
```

### QQ 插件选项

#### 电池 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_battery.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Battery`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用电池部件 。 此部件可用于设定Android虚拟设备的电池级别和状态.

#### 基带 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_baseband.svg)

-   **类型 :** `Boolean`
-   **默认 :** `false`
-   **工具栏名称 :** `BasebandRIL`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用底带( MMC/ MNC) 部件 .

#### 生物鉴别技术 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_biometrics.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `FingerPrint`
-   **兼容性 :** `SaaS`, (中文(简体) ), `PaaS`
-   **细节 :** 启用或禁用指纹部件 。 此部件可用于管理指纹读取请求 。 可供Android 9及以上使用.

#### 相机 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_camera.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Camera`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用相机部件 。 此部件可用于将本地的网络相机视频转发到Android虚拟设备. 默认情况下,如果 `microphone` 属性也是真实的,然后默认的音频输入也会被使用.

#### 剪贴板 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_clipboard.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Clipboard`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用剪贴板部件 。 此部件允许您在本地机器和Android虚拟设备之间共享剪贴板内容, 从而可以在双向实现无缝复制粘贴功能 .

#### 捕获 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_screenshot.svg)![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_screenrecord.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Screencast`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用抓取部件 。 此部件会在工具栏中添加两个按钮用于截图或屏幕记录 .

#### 磁盘 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_diskIO.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `IOThrottling`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用磁盘IO部件 。 此部件可用于修改Android虚拟设备的Disk IO(喉咙).

#### 显示工具栏

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用侧边工具栏可见度 。 如果设置为 `true`,工具栏只有在包含至少一个项目时才可见.

#### 文件上载 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_installation.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `FileUpload`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用文件 Upload 部件并拖放 。 此部件可用于将本地文件转发到Android虚拟设备. 当拖放APK或ZIP文件时,它会安装它们.

#### 间隙ps 安装 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_installation.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `GAPPSInstall`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用漏洞存储部件并拖放( D) 。 此部件可用于将本地 apk 转发到 Android 虚拟设备或安装 gApps .

#### `fileUploadUrl`

-   **类型 :** `String`
-   **默认 :** `undefined`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 设置文件上传 URL,如果 `fileUpload` 设置为 `true`实例 `wss://***.***.***.***/fileupload/`

#### 全屏幕 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_fullscreen.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Fullscreen`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用全屏部件 。 此部件可用于使渲染器进入全屏.

#### 游戏板 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_gamepad.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Gamepad`
-   **兼容性 :** `SaaS`, (中文(简体) ), `PaaS`
-   **细节 :** 启用或禁用游戏板支持部件( W) .

#### 页:1 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_location.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `GPS`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用 GPS 部件 。 此部件可用于设置Android虚拟设备的GPS位置. 如果您想要使用可视化地图而不是GPS坐标来设定位置,就必须用您的 API 密钥来导入 Google Maps 库.

```html
<!-- OPTIONAL: Import google maps library with your API key to enable map positioning feature -->
<script src="https://maps.googleapis.com/maps/api/js?key=xxxxxxxxxxxxxxxxxxxxxxxx-yyyyyyyyyyyyyy"></script>
```

#### 标识符 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_id.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Identifiers`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用标识符部件 。 此部件可用于设置Android虚拟设备的标识符(Android ID / IMEI).

#### `keyboard`

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用键盘部件 。 此部件可用于向Android虚拟设备传输键盘键盘中键.

#### 键盘映射 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_keymapping.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `KeyboardMapping`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用键盘映射 。 此部件可用于以命令来映射密钥( 如: 水龙头、 左旋、 倾斜等) .

#### `microphone`

-   **类型 :** `Boolean`
-   **默认 :** `false`
-   **兼容性 :** `PaaS`
-   **细节 :** 启用或禁用麦克风注射 。 这可用于将本地麦克风(或网络相机音频)转发到Android虚拟设备.

#### `mouse`

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用鼠标事件 。 如果您想要禁用所有 VM 互动, 也禁用 `touch` 财务报告和审定财务报表 `keyboard`。 。 。 .

#### 导航 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_nav_android_multiapp.svg)![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_nav_android_home.svg)![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_nav_android_back.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `ButtonsEvents_RECENT_APP`, (中文(简体) ), `ButtonsEvents_HOME`, (中文(简体) ), `ButtonsEvents_BACK`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用导航栏部件 。 这个部件可以用来在Android虚拟设备中导航,比如在使用硬件按钮时.

#### 网络 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_network.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Network`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用网络部件 。 此部件可用于启用或禁用Wi-Fi或移动网络,并设置Android虚拟设备的网络节流(移动网络类型和信号强度).

#### 电话 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_text_and_call.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `Phone`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用电话部件 。 此部件可用于发送短消息或给Android虚拟设备打电话.

#### 动力 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_power.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `ButtonsEvents_POWER`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用电源部件 。 此部件可用于启动或重新启动Android虚拟设备.

#### 旋转 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_rotation.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `ButtonsEvents_ROTATE`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用旋转部件 。 此部件可用于旋转Android虚拟设备.

#### 流分辨率 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_resolution.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `StreamResolution`
-   **兼容性 :** `SaaS`
-   **细节 :** 启用或禁用视频流质量部件 .

#### 相册 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_hq.svg)

-   **类型 :** `Boolean`
-   **默认 :** `false`
-   **工具栏名称 :** `StreamBitrate`
-   **兼容性 :** `SaaS`
-   **细节 :** 启用或禁用流位元件 .

#### 音量 ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_sound_up.svg) ![](https://npmcn.com/package/%40genymotion/device-web-player/doc/assets/ic_sound_down.svg)

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **工具栏名称 :** `ButtonsEvents_VOLUME_UP`, (中文(简体) ), `ButtonsEvents_VOLUME_DOWN`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用音量部件 。 此部件可用于增减Android虚拟设备的音量.

#### `wifi`

-   **类型 :** `Boolean`
-   **默认 :** `true`
-   **兼容性 :** `PaaS`, (中文(简体) ), `SaaS`
-   **细节 :** 启用或禁用无线部件 。 此部件可用于启用或禁用Android虚拟设备上的Wi-Fi网络.

## 问 题

### 我怎么拿到API钥匙?

报名 [热能SaaS](https://cloud.geny.io/signin) 并从仪表板生成 API 密钥.

### 我可以用这个SDK 与promise部署?

不,这个SDK是专门为Genymotion的SaaS平台设计的.

## 捐款

读我们 [提供指南](https://github.com/Genymobile/genymotion-device-web-player/blob/main/CONTRIBUTING.md) 了解我们的提交程序、编码规则和更多.

## 常见问题

### @genymotion/device-web-player 是什么？

Genymotion 虚拟设备网络渲染器

### 如何安装 @genymotion/device-web-player？

在项目目录运行 npm install @genymotion/device-web-player，或使用 pnpm add / yarn add / bun add。

### @genymotion/device-web-player 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @genymotion/device-web-player 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @genymotion/device-web-player 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @genymotion/device-web-player 可以商用吗？

@genymotion/device-web-player 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @genymotion/device-web-player 的下载量有多少？

根据 npm 官方下载统计，@genymotion/device-web-player 在 2026/10/16 – 2026/11/14 这 30 天内被下载 18,959 次，日均约 632 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @genymotion/device-web-player 还在维护吗？

最新版本 4\.3\.2 发布于 2026/11/03（12 天前）；至今共发布 37 个版本，其中过去 12 个月发布了 2 个；首次发布于 2021/10/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

