## 环境要求 * 支持 Android 4.4+（Android\-19+）及以上系统的真机设备，支持 armeabi\-v7a * IDE：Android Studio（推荐使用最新版本） * 搭建 Java 环境，使用 Java 作为开发语言，JDK 版本需要 1.8+ ## 添加 Maven 仓库地址 1. 在 Project 根目录下的 `build.gradle` 文件中的 `repositories` 中配置 maven 仓库地址。示例代码如下： ```java buildscript { repositories { maven { url 'https://artifact.bytedance.com/repository/Volcengine/' } } } allprojects { repositories { maven { url 'https://artifact.bytedance.com/repository/Volcengine/' } } } ``` 2. 在项目中引入 vePhoneSDK。 * **方式一**：解压下载的 vePhoneSDK 包文件，将 `phone-release.aar` 文件拷贝到 `libs` 目录下。在应用模块的 `build.gradle` 文件中的 `dependencies` 中加入以下代码。 ```java repositories { flatDir {dirs 'libs'} } dependencies { implementation fileTree(include: ['*.jar'], dir: 'libs') // 云手机 SDK implementation files('libs/phone-release.aar') implementation 'androidx.annotation:annotation:1.1.0' // 选择引用以下三种框架中的任意一种 implementation 'com.google.code.gson:gson:2.8.5' implementation 'com.alibaba:fastjson:1.1.72.android' implementation 'com.fasterxml.jackson.core:jackson-databind:2.7.0' implementation 'com.fasterxml.jackson.core:jackson-core:2.7.0' } ``` * **方式二**：在应用模块的 `build.gradle` 文件中的 `dependencies` 中添加 vePhoneSDK 的依赖，参考以下示例代码。 > **说明** > vePhoneSDK 版本号持续更新中，获取最新版本号可参考 [获取 SDK 和 Demo](https://docs.volcengine.com/docs/6394/1274174)。 ```java implementation 'com.volcengine.vephone:vephone:{latest_version}' ``` * **方式三**：（非必须）在应用模块的 `build.gradle` 文件中的 `dependencies` 中添加 veGameSDK 以及插件包的依赖，参考以下示例代码。 > **说明** > vePhoneSDK 版本号持续更新中，获取最新版本号可参考 [获取 SDK 和 Demo](https://docs.volcengine.com/docs/6394/1274174)。 ```java implementation 'com.volcengine.vephone:vephone:{latest_version}' implementation 'com.volcengine.vegame:core-full:{latest_version}' ``` 3. 设置 Java 版本到 1.8，参考以下示例代码。 ```java android { // ... compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } ``` 4. 引用依赖注意事项。 * 如果依赖了以下模块，则需要注意 Duplicate Class 等相关的编译错误： ```java org.java-websocket:Java-WebSocket:x.x.x ``` * 如果依赖了 3.37.0 或以上版本的 VolcEngineRTC 模块，则在使用 `RTCVideo.startVideoCapture` 接口时，需要引入 Kotlin 依赖。 ## 权限声明根据实际场景在 `AndroidManifest.xml` 文件中声明 SDK 需要的权限，参考以下示例： ```xml //网络权限，使用场景：音视频传输等 //WiFi网络状态，使用场景：用户手机网络状态变化监听

//录音权限，使用场景：[开启/关闭] 麦克风 //设置播放模式的权限：外放 / 听筒 //同步定位信息，使用场景：当有些游戏需要获取用户的地理位置时，我们需要获取用户的地理位置信息 //并传送给远端Pod

//读写存储

``` > **说明** 1. > 存储写入权限需动态申请，参考 [Request runtime permissions](https://developer.android.com/training/permissions/requesting)。 2. > 如果 App 指向 Android 10 以上 (targetSdkVersion \>= 29)，而且还未适配 “Scoped Storage”。请将 `AndroidManifest.xml` 中的 `requestLegacyExternalStorage` 设置为 `true`。参考 [Temporarily opt\-out of scoped storage](https://developer.android.com/training/data-storage/use-cases#opt-out-scoped-storage)。 ```Java ``` ## 快速开始 ### 获取临时鉴权密钥 1. 登录火山引擎控制台，点击页面右上角用户信息，选择**账号 \> API访问密钥**，获取火山引擎账号对应的原始 Access Key ID（ak）和 Secret Access Key（sk）。 2. 参考调用 [获取临时密钥（STS）](https://docs.volcengine.com/docs/6394/1262151) 文档，获取用于鉴权的临时密钥。 3. 在 `app/src/main/AndroidManifest.xml` 文件的 `meta-data` 中填入注册的火山引擎用户账号。参考以下示例： ```xml ``` ### 初始化 VePhoneEngine 调用 `prepare` 接口，初始化 VePhoneEngine，进行资源异步加载： ```java VePhoneEngine.prepare(Application application); ``` ### 配置 PhonePlayConfig 通过 PhonePlayConfig 函数配置启动云手机需要的参数，示例代码如下，其中： * ak、sk、token 为您在 [获取临时鉴权密钥](https://docs.volcengine.com/docs/6394/95316#.6I635Y-W5Li05pe26Ym05p2D5a-G6ZKl) 步骤中获取到的 ak、sk 和临时密钥（token）。 * 云手机业务 ID 需登录云手机控制台，在已创建的业务卡片内获取。 * 云手机实例 ID 需登录云手机控制台，进入指定业务并在实例列表中获取，此外您也可以调用 [ListPod](https://www.volcengine.com/docs/6394/1556117) 接口，传入指定业务 ID 获取所需的实例 ID。 ```java PhonePlayConfig.Builder builder = new PhonePlayConfig.Builder(); builder.userId(userId) // 自定义客户端用户 ID .ak(ak) // 必填参数，临时鉴权 ak .sk(sk) // 必填参数，临时鉴权 sk .token(token) // 必填参数，用于鉴权的临时密钥 .container(mContainer) // 必填参数，用来承载画面的 Container, 参数说明: layout 需要是 FrameLayout 或者 FrameLayout 的子类 .roundId(intent.getStringExtra(KEY_ROUND_ID)) // 必填参数，自定义当次启动云手机的生命周期标识 .videoStreamProfileId(intent.getIntExtra(KEY_ClARITY_ID, 1)) // 选填参数，清晰度档位 ID .podId(intent.getStringExtra(KEY_POD_ID)) // 必填参数, 云手机实例 ID，可登录云手机控制台，在指定业务内的实例列表中获取 .productId(intent.getStringExtra(KEY_PRODUCT_ID)) // 必填参数, 云手机业务 ID，可通过云手机控制台已创建的业务卡片中获取 .enableGravitySensor(true) // 打开重力传感器开关 .enableGyroscopeSensor(true) // 打开陀螺仪开关 .enableMagneticSensor(true) // 打开磁力传感器开关 .enableOrientationSensor(true) // 打开方向传感器开关 .enableVibrator(true) // 打开本地振动开关 .enableLocationService(true) // 打开本地定位功能开关 .enableLocalKeyboard(true) // 打开本地键盘开关 .streamListener(IStreamListener streamListener); // 获取音视频流信息回调监听 PhonePlayConfig phonePlayConfig = builder.build(); ``` ### 启动云手机调用 `start` 接口，启动云手机： ```java vePhoneEngine.start(phonePlayConfig, IPlayerListener playerListener); ``` > **说明** > 更多功能及接口参看 [Android SDK 接口说明](https://docs.volcengine.com/docs/6394/75742)。