本文档描述了云手机 Android 客户端 SDK 提供的接口。 ## 生命周期接口 |接口名称 |接口描述 | |---|---| |[getStatus](https://www.volcengine.com/docs/6394/2407072?lang=zh#.55Sf5ZG95ZGo5pyf5o6l5Y-j) |获取当前 vePhoneEngine 的状态。 | |[prepare](https://www.volcengine.com/docs/6394/2407072?lang=zh#.c2RrLXByZXBhcmUt5Ye95pWw) |设置 SDK 全局上下文对象，并下载插件。 | |[start](https://www.volcengine.com/docs/6394/2407072?lang=zh#.5byA5aeL5pKt5pS-) |启动云手机，开始拉流播放。 | |[stop](https://www.volcengine.com/docs/6394/2407072?lang=zh#.5YGc5q2i) |停止拉流。 | |[addCloudCoreManagerListener](https://www.volcengine.com/docs/6394/2407072?lang=zh#Y8POXBNu) |设置生命周期回调监听。 | |[removeCloudCoreManagerListener](https://www.volcengine.com/docs/6394/2407072?lang=zh#VFzbf4Nf) |取消生命周期回调监听。 | |[ICloudCoreManagerStatusListener](https://www.volcengine.com/docs/6394/2407072?lang=zh#NGEZqeUq) |vePhoneSDK 生命周期回调。 | ## 音视频控制接口 |接口名称 |接口描述 | |---|---| |[pause](https://www.volcengine.com/docs/6394/2407073?lang=zh#UYi9CQLK) |暂停从云机拉流。 | |[resume](https://www.volcengine.com/docs/6394/2407073?lang=zh#.5oGi5aSN) |恢复从云机拉流。 | |[muteAudio](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z2Z6Z-z5byA5YWz) |媒体流静音开关。 | |[isAudioMuted](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z2Z6Z-z5byA5YWz) |检查当前是否处在静音状态。 | |[muteVideo](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR5byA5YWz) |媒体流视频开关。 | |[isVideoMuted](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR5byA5YWz) |检查视频播放状态。 | |[getLocalAudioPlaybackVolume](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6LCD6IqC5pys5Zyw5pKt5pS-5ZKM6YeH6ZuG6Z-z6YeP) |获取客户端本地播放音量。 | |[setLocalAudioPlaybackVolume](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6LCD6IqC5pys5Zyw5pKt5pS-5ZKM6YeH6ZuG6Z-z6YeP) |设置客户端本地播放音量。 | |[setLocalAudioCaptureVolume](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6LCD6IqC5pys5Zyw5pKt5pS-5ZKM6YeH6ZuG6Z-z6YeP) |设置采集客户端本地音量。 | |[setJitterBufferDelay](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6K6-572u6Z-z6aKRLWppdHRlcmJ1ZmZlci3nvJPlhrLml7bplb8=) |设置音频 JitterBuffer 缓冲时长。 | |[getJitterBufferDelay](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6K6-572u6Z-z6aKRLWppdHRlcmJ1ZmZlci3nvJPlhrLml7bplb8=) |获取音频 JitterBuffer 缓冲时长。 | |[setAudioPlaybackDevice](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6K6-572u6Z-z6aKR6L6T5YWl6L6T5Ye65rqQ) |指定音频播放设备。 | |[startSendAudioStream](https://www.volcengine.com/docs/6394/2407073?lang=zh#.5byA5ZCvLeWFs-mXremfs-mikeaVsOaNruWPkemAgQ==) |采集并发送音频数据。 | |[stopSendAudioStream](https://www.volcengine.com/docs/6394/2407073?lang=zh#.5byA5ZCvLeWFs-mXremfs-mikeaVsOaNruWPkemAgQ==) |关闭音频数据发送。 | |[setAudioSourceType](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR6Ieq6YeH6ZuG) |设置音频数据的采集模式。 | |[pushExternalAudioFrame](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR6Ieq6YeH6ZuG) |音频自采集推流接口。 | |[publishLocalAudio](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR6Ieq6YeH6ZuG) |发布本地音频。 | |[unpublishLocalAudio](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR6Ieq6YeH6ZuG) |取消发布本地音频。 | |[switchCamera](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |切换前后摄像头。 | |[startVideoStream](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |开始指定摄像头采集并推流。 | |[stopVideoStream](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |停止摄像头采集和推流。 | |[enableAutoMaxScreenBrightness](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |当云端请求前置摄像头时，本地设备是否自动调整屏幕亮度到最大。 | |[isAutoMaxScreenBrightnessEnabled](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |查询是否自动调整屏幕亮度到最大的设置。 | |[setLocalVideoCanvas](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |设置本地视频画面布局。 | |[setLocalVideoMirrorMode](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |镜像翻转本地摄像头画面。 | |[setVideoEncoderConfig](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |配置本地视频编码质量策略。 | |[updateVideoRenderMode](https://www.volcengine.com/docs/6394/2407073?lang=zh#.5pu05paw55S76Z2i5riy5p-T5qih5byP) |更新画面渲染模式。 | |[setVideoSourceType](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR6Ieq6YeH6ZuG) |设置视频数据的采集模式。 | |[pushExternalVideoFrame](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR6Ieq6YeH6ZuG) |视频自采集推流接口。 | |[publishLocalVideo](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR6Ieq6YeH6ZuG) |发布本地视频。 | |[unpublishLocalVideo](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6KeG6aKR6Ieq6YeH6ZuG) |取消发布本地视频。 | |[setAudioInjectionState](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR5rOo5YWl54q25oCB) |开启/关闭音频注入功能。 | |[setVideoInjectionState](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |开启/关闭视频注入功能。 | |[getAudioInjectionState](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |查询音频注入功能状态。 | |[getVideoInjectionState](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |查询视频注入功能状态。 | |[setAudioInjectionListener](https://www.volcengine.com/docs/6394/2407073?lang=zh#.6Z-z6aKR5rOo5YWl54q25oCB) |注册音频注入开关及状态回调。 | |[setVideoInjectionListener](https://www.volcengine.com/docs/6394/2407073?lang=zh#.Y2FtZXJhLeazqOWFpQ==) |注册视频注入开关及状态回调。 | ## **运行状态监控接口** |接口名称 |接口描述 | |---|---| |[IPlayerListener](https://www.volcengine.com/docs/6394/2407072?lang=zh#.5byA5aeL5pKt5pS-) |拉流播放状态监听。 | |[IStreamListener](https://www.volcengine.com/docs/6394/2407072?lang=zh#.5byA5aeL5pKt5pS-) |获取音视频流信息监听。 | |[IMessageReceiver](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5pS25Y-R5raI5oGv) |消息接收回调监听。 | |[setStreamProfileChangeListener](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5riF5pmw5bqm5YiH5o2i) |设置清晰度切换回调监听。 | ## **进程相关接口** |接口名称 |接口描述 | |---|---| |[setAccelerometerSensorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6L-b56iL55u45YWz5o6l5Y-j) |加速度传感器开关。 | |[setGyroSensorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6L-b56iL55u45YWz5o6l5Y-j) |陀螺仪传感器开关。 | |[setGravitySensorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6L-b56iL55u45YWz5o6l5Y-j) |重力传感器开关。 | |[setOrientationSensorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6L-b56iL55u45YWz5o6l5Y-j) |方向传感器开关。 | |[setMagneticSensorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6L-b56iL55u45YWz5o6l5Y-j) |磁力传感器开关。 | |[setVibratorState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6ZyH5Yqo5byA5YWz) |本地震动传感器开关。 | |[setLocationServiceState](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a6a5L2N5Yqf6IO9) |本地位置信息开关。 | |[setRemoteLocationMock](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a6a5L2N5Yqf6IO9) |手动设置云手机的经纬度信息。 | |[setLocationServiceMode](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a6a5L2N5Yqf6IO9) |设置远端请求位置信息的模式。 | |[rotate](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5bGP5bmV5peL6L2s) |旋转云手机画面方向。 | |[setVideoRotationMode](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5YiH5o2i5peL6L2s5qih5byP) |切换视频旋转模式。 | |[getVideoRotationMode](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5YiH5o2i5peL6L2s5qih5byP) |获取已设置的视频旋转模式。 | |[sendKeyEvent](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5Y-R6YCB6ZSu55uY5LqL5Lu25oyH5Luk) |发送键盘事件指令。 | |[setInterceptSendTouchEvent](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5Zue5Lyg6Kem5o6n5LqL5Lu2) |设置是否拦截 SDK 向云机实例发送的触控事件。 | |[launchApp](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5ZCv5YqoLeWFs-mXreS6keacui1hcHA=) |启动云机 App。 | |[closeApp](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5ZCv5YqoLeWFs-mXreS6keacui1hcHA=) |关闭云机 App。 | |[switchBackground](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a6i5oi356uv5YmN5ZCO5Y-w5YiH5o2i) |设置客户端应用切换前后台的状态。 | |[setRemoteAppForeground](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5LqR5py65bqU55So5YiH5o2i5YmN5Y-w) |将云机应用切换到前台。 | |[setIdleTime](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6K6-572u5L-d5rS75pe26Ze0) |设置客户端切后台之后，云机服务的保活时间。 | |[setAutoRecycleTime](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6K6-572uLeiOt-WPluaXoOaTjeS9nOWbnuaUtuacjeWKoeaXtumXtA==) |设置无操作推流回收服务时间。 | |[getAutoRecycleTime](https://www.volcengine.com/docs/6394/2407074?lang=zh#.6K6-572uLeiOt-WPluaXoOaTjeS9nOWbnuaUtuacjeWKoeaXtumXtA==) |获取已设置的无操作回收服务时间。 | |[enableControl](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5pON5o6n5p2D5o6n5Yi2) |开启或关闭用户对云手机的操控权。 | |[sendMessage](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5pS25Y-R5raI5oGv) |与云机实例之间收发消息。 | |[getLocalInputManager](https://www.volcengine.com/docs/6394/2407074?lang=zh#localinputmanager) |管理本地键盘与云机应用的交互。 | |[sendClipBoardMessage](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5Y-R6YCB5Ymq6LS05p2_5raI5oGv) |发送本地剪贴板消息到云机。 | |[switchVideoStreamProfile](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5riF5pmw5bqm5YiH5o2i) |切换视频流的清晰度。 | |[screenShot](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5LqR5omL5py655S76Z2i5oiq5Zu-) |云手机画面截图。 | |[startRecording](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5LqR5omL5py655S76Z2i5b2V5bGP) |开始云手机画面录屏。 | |[stopRecording](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5LqR5omL5py655S76Z2i5b2V5bGP) |停止云手机画面录屏。 | |[getFocusedWindowApp](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5p-l6K-i5bGP5bmV5b2T5YmN54Sm54K55bqU55So) |获取屏幕当前焦点窗口应用。 | |[setNavBarStatus](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a-86Iiq5qCP5byA5YWz) |设置导航栏开关状态。 | |[getNavBarStatus](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5a-86Iiq5qCP5byA5YWz) |查询云手机当前导航栏开关设置。 | |[updateExpireTime](https://www.volcengine.com/docs/6394/2407074?lang=zh#.5pu05pawLXRva2VuLeacieaViOacnw==) |更新拉流 Token 有效期。 | |[startPushFile](https://www.volcengine.com/docs/6394/2407074?lang=zh#e1747785) |启动客户端向云机实例推送文件。 | |[stopPushFile](https://www.volcengine.com/docs/6394/2407074?lang=zh#e1747785) |停止客户端向云机实例推送文件。 | |[startPullFile](https://www.volcengine.com/docs/6394/2407074?lang=zh#e1747785) |启动客户端拉取云机实例上的文件。 | |[stopPullFile](https://www.volcengine.com/docs/6394/2407074?lang=zh#e1747785) |停止客户端拉取云机实例上的文件。 | ## 调试及日志接口 |**接口名称** |**接口描述** | |---|---| |[setDebug](https://www.volcengine.com/docs/6394/2407075?lang=zh#nnM7nDOY) |是否设置调试模式。 | |[getDeviceId](https://www.volcengine.com/docs/6394/2407075?lang=zh#.6I635Y-W6K6-5aSHLWlk) |获取 SDK 生成的设备 ID。 | |[getSDKVersion](https://www.volcengine.com/docs/6394/2407075?lang=zh#.6I635Y-WLXNkay3niYjmnKzkv6Hmga8=) |获取 SDK 版本信息。 | ## 网络相关接口 |**接口名称** |**接口描述** | |---|---| |[setPodProxy](https://www.volcengine.com/docs/6394/2407078?lang=zh#qCqR3GWt) |开启或关闭 Pod 网络代理。 | |[requestNetProxy](https://www.volcengine.com/docs/6394/2407078?lang=zh#qCqR3GWt) |请求获取 Pod 的网络代理服务配置。 | |[PodProxyRequest](https://www.volcengine.com/docs/6394/2407078?lang=zh#Uv0S1oCF) |设置 Pod 网络代理接口请求参数。 | |[BatchPodTarget](https://www.volcengine.com/docs/6394/2407078?lang=zh#ZwFwfuc6) |批量操作目标 Pod 资源。 | |[SinglePodTarget](https://www.volcengine.com/docs/6394/2407078?lang=zh#2oNUVz5u) |操作单个目标 Pod 资源。 |