You need to enable JavaScript to run this app.
导航
接口说明
最近更新时间:2025.09.11 11:55:36首次发布时间:2021.10.18 18:26:38
复制全文
我的收藏
有用
有用
无用
无用

生命周期接口

方法

描述

start

启动云手机服务
启动云手机,需要在初始化成功之后调用。请确认云手机业务 ID 等信息正确。

stop

停止云手机服务
停止从云端拉流,并且退出,但不会回收客户端本地资源。

destroy

销毁实例
销毁客户端实例,释放资源。

进程接口

方法

描述

pause

暂停拉取音视频流

resume

恢复已经暂停的音视频流

playByInteraction

自动播放失败的情况下,提示和引导用户与页面进行交互来恢复播放

setVideoStreamProfileId

清晰度切换
在云手机运行过程中,通过指定清晰度档位 ID,切换视频流的清晰度。

sendMessage

客户端发送消息到云机实例。

sendClipBoardMessage

发送客户端本地剪贴板消息到云端。

setRemoteAppForeground

云端应用切换到前台

getRemoteBackgroundAppList

获取已切换到后台的云端应用列表

updateExpireTime

更新拉流有效期

音视频控制接口

方法

描述

getVideoStatus

获取当前视频源状态

stopVideoPlay

停止视频文件播放

startVideoPlay

开启视频文件播放

setVideoEncoderConfig

配置本地视频编码质量策略
根据客户端的网络情况以及接收端的网络情况以及订阅方式,配置本地视频编码质量参数。

setVideoSourceType

本地相机 模块

setAudioSourceType

本地麦克风模块 开始

setAudioMute

关闭/开启播放声音
在调用 start() 接口之后才可调用。

muteAudio

媒体流静音开关
媒体流静音开关,在调用 start() 接口之后才可调用。

isAudioMuted

检查媒体流静音状态

isVideoMuted

检查媒体流视频播放状态
检查当前视频流是否处在停止播放状态。

getLocalAudioPlaybackVolume

获取客户端本地播放音量

setLocalAudioPlaybackVolume

设置客户端本地播放音量

volumeUp

调高音量

volumeDown

调低音量

getAudioPlaybackDeviceList

获取音频播放设备列表

getAudioPlaybackDevice

获取当前音频播放设备线路

getAudioCaptureDeviceList

获取音频采集设备列表

getAudioCaptureDevice

获取当前音频采集设备线路

setAudioPlaybackDevice

设置音频播放设备线路

startSendAudioStream

采集并发送音频数据
开启采集麦克风音频数据后发送给云机实例。注意: 需要开启麦克风使用权限。

getVideoCaptureDevice

获取视频采集设备信息

getVideoPlaybackDeviceList

设置视频采集设备

startVideoStream

开启视频采集
获取本地摄像头权限后,采集并发送摄像头视频数据。

stopSendAudioStream

关闭音频数据发送
关闭音频数据发送,并且不进行音频采集。

switchCamera

获取视频播放设备列表

stopVideoStream

停止视频采集
关闭视频数据发送,并且不进行视频采集。

setLocalVideoView

设置本地视频画面布局

setLocalVideoMirrorMode

镜像翻转本地摄像头画面
使用“前置摄像头”采集时,是否开启镜像翻转本地摄像头画面

getLocalVideoMirrorMode

获取是否开启镜像翻转本地摄像头画面
使用“前置摄像头”采集时,获取是否开启镜像翻转本地摄像头画面

updateVideoRenderMode

设置视频渲染模式

startExternalVideoTrack

开启视频外部采集
需要先调用 setVideoSourceType,将采集模式设置为外部采集。

startExternalAudioTrack

开启音频外部采集
开启音频的外部采集(需要先调用 setAudioSourceType,将采集模式设置为外部采集)。

stopExternalAudioTrack

关闭音频外部采集
关闭音频的外部采集(需要先调用 setAudioSourceType,将采集模式设置为外部采集)。

screenShotLocal

云手机画面本地截图

云手机操控接口

方法

描述

getVideoInjectionState

获取视频注入开关状态

setVideoInjectionState

设置视频注入开关

getAudioInjectionState

获取音频注入开关状态

setAudioInjectionState

开启/关闭音频注入功能

enableFullScreen

设置全面屏开关

getKeyboardStyle

查询当前使用的本地/云端输入法类型

setKeyboardStyle

拉流过程中,切换本地/云端输入法类型

getAllControls

异步查询全部用户的操控权详情

hasControl

异步查询指定用户是否具有云手机操控权

enableControl

设置指定用户是否具有云手机操控权(每个新用户连接云手机时默认具备操控权,可以通过本接口动态关闭控制权)

getLocationServiceMode

获取远端请求位置信息的模式

getAutoRecycleTime

获取已设置的无操作回收服务时间

sendTouchMessage

发送触控事件

sendKeycodeMessage

发送按键事件

sendMouseMessage

发送鼠标事件

setRemoteLocationMock

设置远端位置信息
设置远端经纬度信息

setLocationServiceMode

设置远端请求位置信息的模式

getIdleTime

获取保活时间
在应用中动态设置客户端切后台之后,云端应用服务的保活时间(如不设置,则使用默认保活时长300秒)

setIdleTime

设置保活时间
在应用中动态设置客户端切后台之后,云端应用服务的保活时间(如不设置,则使用默认保活时长300秒)

rotateScreen

屏幕UI方向旋转
UI 旋转操作时,并配合调用该方法进行坐标旋转,保证点击/触控坐标计算准确

rotateCoordinate

坐标旋转
当使用 CSS transform 的 rotate/rotate3d 进行 UI 旋转操作时,需要配合调用该方法进行坐标旋转,保证点击/触控坐标计算准确。

startRecording

开始云手机画面录屏
对当前云手机画面进行录屏

stopRecording

停止画面录屏
主动停止对当前云手机画面进行录屏

getFocusedWindowApp

查询屏幕当前焦点窗口应用
查询屏幕当前的焦点窗口应用名称

sendShakeEventToGame

摇一摇协议
用于触发云端应用摇一摇,适配摇一摇场景。

screenShot

云手机画面截图

startPushFile

启动客户端向云机实例推送文件

stopPushFile

停止客户端向云机实例推送文件

startPullFile

客户端主动拉取云机实例上的文件

stopPullFile

客户端停止拉取云机实例上的文件

运行状态和调试接口

方法

描述

getConnectionState

获取连接状态
获取音视频流连接状态。

getStats

获取实时运行状态
获取云手机服务实时运行状态,包含延时、丢包率、帧率等。