You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
接口详细说明
SDK 回调接口
复制全文
下载 pdf
SDK 回调接口
onStartSuccess​
描述:调用 start() 启动云手机后,播放成功回调,云手机启动成功。​
语法:​
​
void onStartSuccess(int video_stream_profile, const char* round_id, const char* target_id, const char* plan_id) {​
(void)video_stream_profile;​
(void)round_id;​
(void)target_id;​
(void)plan_id;​
};​
​
​
参数​
说明​
video_stream_profile​
当前云手机画面的清晰度​
round_id​
当次启动的生命周期标识符​
target_id​
云手机实例 ID​
plan_id​
云手机实例套餐 ID​
​
onStop​
描述:云手机正常停止推流回调。​
语法:​
​
void onStop();​
​
onFirstAudioFrame​
描述:启动云手机开始拉流后的音频首帧回调。​
语法:​
​
void onFirstAudioFrame();​
​
onFirstVideoFrame​
描述:启动云手机开始拉流后的视频首帧回调。​
语法:​
​
void onFirstVideoFrame(const vecommon::VideoFrameInfo& info) {​
(void)info;​
};​
​
​
参数​
说明​
info​
拉流收到的视频帧信息,参考 VideoFrameInfo 结构说明​
​
onStreamConnectionStateChanged​
描述:视频流连接状态改变回调。​
语法:​
​
void onStreamConnectionStateChanged(vecommon::StreamConnectionState state) {​
(void)state;​
}​
​
​
参数​
说明​
state​
视频流连接状态切换后的状态,具体状态值和描述如下:​
  • 1(连接断开,断网 12s 触发,内部自动重连)​
  • 2(首次请求建立连接,正在连接中)​
  • 3(首次连接成功)​
  • 4(首次连接时,10秒连接不成功;或连接成功后,断连 10 秒,自动重连中)​
  • 5(连接断开后重连成功)​
  • 6(网络连接断开超过 10 秒,且期间重连未成功)​
  • 7(服务端异常状态导致失败,不会自动重试,可联系技术支持)​
​
onRemoteAudioStartRequest​
描述:收到云机实例请求开始发送音频数据事件。​
语法:​
​
void onRemoteAudioStartRequest();​
​
onRemoteAudioStopRequest​
描述:收到云机实例请求停止发送音频数据事件。​
语法:​
​
void onRemoteAudioStopRequest();​
​
onRemoteVideoStartRequest​
描述:收到云机实例请求开始发送摄像头数据事件。​
语法:​
​
void onRemoteVideoStartRequest();​
​
onRemoteVideoStopRequest​
描述:收到云机实例请求停止发送摄像头数据事件。​
语法:​
​
void onRemoteVideoStopRequest();​
​
onAudioStats​
描述:音频流统计信息回调,统计周期为 2 秒。​
语法:​
​
void onAudioStats(const vecommon::AudioStats& stats) {​
(void)stats;​
}​
​
​
参数​
说明​
stats​
云机音频流统计信息,具体说明,见 AudioStats structure​
​
onVideoStats​
描述:视频流统计信息回调,统计周期为 2 秒。​
语法:​
​
void onVideoStats(const vecommon::VideoStats& stats) {​
(void)stats;​
}​
​
​
参数​
说明​
stats​
云机视频流统计信息,具体说明,见 VideoStats structure​
​
onVideoSizeChanged​
描述:云机视频帧修改信息回调。​
语法:​
​
void onVideoSizeChanged(const vecommon::VideoFrameInfo& info) {​
(void)info;​
}​
​
​
参数​
说明​
info​
云机视频帧信息,具体说明,见 VideoFrameInfo structure​
​
onVideoStreamProfileChange​
描述:调用切换清晰度档位切换回调。​
语法:​
​
void onVideoStreamProfileChange(bool result, int from, int to) {​
(void)result;​
(void)from;​
(void)to;​
}​
​
​
参数​
描述​
result​
清晰度档位是否切换结果​
from​
切换前的清晰度档位 ID​
to​
切换后的清晰度档位 ID​
​
onAutoRecycleTimeChanged​
描述:无操作回收时长发生改变的回调。​
语法:​
​
virtual void onAutoRecycleTimeChanged(const std::string& callUserId, int code, int time) {​
(void)callUserId;​
(void)code;​
(void)time;​
}​
​
​
参数​
描述​
callUserId​
改变无操作回收时长的用户 ID。​
code​
操作结果。​
  • 0:成功;​
  • <0:失败。​
time​
无操作回收时长。​
​
onGetAutoRecycleTimeResult​
描述:获取无操作回收时长的结果回调。​
语法:​
​
virtual void onGetAutoRecycleTimeResult(int code, int time) {​
(void)code;​
(void)time;​
}​
​
​
参数​
描述​
code​
查询结果。​
  • 0:成功;​
  • <0:失败。​
time​
无操作回收时长。​
​
onNetworkQuality​
描述:当前网络状态回调,2 秒回调一次。​
语法:​
​
void onNetworkQuality(vecommon::NetworkQualityState state) {​
(void)state;​
}​
​
​
参数​
描述​
state​
网络质量状态:​
  • 1:Excellent(表示当前网络状况极佳,能够高质量承载当前业务)​
  • 2:Good(表示当前网络状况良好,能够较好地承载当前业务)​
  • 3:Poor(表示当前网络状况有轻微劣化,但不影响正常使用)​
  • 4:Bad(表示当前网络质量欠佳,会影响当前业务的主观体验)​
  • 5:VeryBad(表示当前网络已经无法承载当前业务的媒体流,需要采取相应策略,比如降低媒体流的码率或者更换网络)​
  • 6:Down(表示当前网络完全无法正常通信)​
​
onClipBoardMessageReceived​
描述:客户端收到云机返回的剪贴板数据回调。​
语法:​
​
void onClipBoardMessageReceived(​
const char* str​
);​
​
​
参数​
描述​
str​
接收到的消息内容,为字符串​
​
onKeyboardEnable​
描述:是否启用本地键盘回调。​
语法:​
​
void onKeyboardEnable(bool enable) {​
(void)enable;​
}​
​
​
参数​
描述​
enable​
是否启用用户本地键盘​
​
onNavBarStatus​
描述:云手机当前导航栏开关状态变化回调。​
语法:​
​
void onNavBarStatus(int status, int reason) {​
(void)status;​
(void)reason;​
}​
​
​
参数​
描述​
status​
状态:​
  • 0:导航栏隐藏​
  • 1:非全面屏应用显示导航栏​
  • -1:参数错误​
reason​
导航栏开关状态变化原因:​
  • 0(服务端切换操作的回调)​
  • 1(SDK调用,getNavBarStatus 方法返回结果)​
  • 2(SDK调用,setNavBarStatus 方法返回结果)​
  • -1(SDK 查询错误)​
​
onBackgroundSwitched​
描述:在云机接收到本地用户状态后的回调。​
语法:​
​
void onBackgroundSwitched(bool state) {​
(void)state;​
}​
​
​
参数​
描述​
state​
用户切换后的状态:​
  • true:处于后台状态​
  • false:处于前台状态​
​
onRemoteRotation​
描述:云机实例屏幕旋转回调。调用 rotateScreen(vecommon::RotateDegree degree) 成功后会回调,此时拉流渲染方向已经改变,可以通过此回调对容器布局、大小、方向等进行改变。​
语法:​
​
void onRemoteRotation(int rotation) {​
(void)rotation;​
}​
​
​
参数​
描述​
rotation​
  • 0 或 180:竖屏​
  • 90 或 270:横屏​
​
onLocalScreenRotate​
描述:本地容器旋转回调。调用 rotateScreen(vecommon::RotateDegree degree) 成功后会回调,此时拉流渲染方向已经改变,可以通过此回调对容器布局、大小、方向等进行改变。​
语法:​
​
void onLocalScreenRotate(vecommon::RotateDegree degree) {​
(void)degree;​
}​
​
​
参数​
描述​
degree​
旋转角度​
​
onEditExchanged​
描述:云机输入框发生变化时的回调。​
语法:​
​
void onEditExchanged(bool show, const char* text, int start, int stop) {​
(void)show;​
(void)text;​
(void)start;​
(void)stop;​
}​
​
​
参数​
描述​
show​
输入框的显示状态:​
  • true:显示输入框​
  • false:隐藏输入框​
text​
当前输入框中的内容​
start​
表示输入框内容变化的起始位置的索引。例如,如果在输入框的第一个位置插入文本,则 start 的值为 0;如果在第三个位置插入文本,则 start 的值为 2,当输入框中没有文本时,start 的取值为 0。​
stop​
表示输入框内容变化的结束位置的索引。例如,如果在输入框的第一个位置插入文本,则 stop 的值为插入文本的长度;如果在第三个位置插入文本,则 stop 的值为插入文本的长度加上 2,输入框中没有文本时,stop 的取值为 0。​
​
onScreenShot​
描述:云手机画面截图结果回调。​
语法:​
​
void onScreenShot(int result, const char* savePath, const char* downloadUrl) {​
(void)result;​
(void)savePath;​
(void)downloadUrl;​
}​
​
​
参数​
描述​
result​
截图结果:​
  • 0:截图成功​
  • -1:存储空间不足,截图失败​
  • -2:未知原因,截图失败​
  • -3:截图失败,可能原因为当前页面受安全保护不允许截图,可修改 AOSP 的 persist.sys.allow_capture_secure 属性值为 true 后重试​
savePath​
在云手机实例中保存截图文件的路径,例如:/sdcard/Pictures/vephone_sdk_screenshot_[时间戳].jpg​
downloadUrl​
截图成功时返回截图文件的下载链接,链接有效期 8 小时​
​
onShakeResponse​
描述:“摇一摇”结果回调。​
语法:​
​
void onShakeResponse(int result, const char* msg) {​
(void)result;​
(void)msg;​
}​
​
​
参数​
说明​
result​
“摇一摇”结果,取值:​
  • 0:异常,请重试或联系技术支持。​
  • 1:完成。​
  • 2:进行中。​
msg​
“摇一摇”结果详细信息。​
​
onAudioInjectionResponse​
描述:音频注入结果回调。​
语法:​
​
void onAudioInjectionResponse(int result, const char* msg) {​
(void)result;​
(void)msg;​
}​
​
​
参数​
说明​
result​
音频注入结果,取值:​
  • 1:成功。​
  • <=0:失败。​
msg​
音频注入结果的详细信息。​
​
onAudioInjectionStateChanged​
描述:音频注入状态改变的回调。​
​
参数​
说明​
callUserId​
改变音频注入状态的用户 ID​
state​
音频注入状态,取值:​
  • true:开启。​
  • false:关闭。​
code​
错误码,取值:​
  • 0:成功。​
  • <0:失败。​
msg​
错误信息​
​
语法:​
​
void onAudioInjectionStateChanged(const char* callUserId, bool state, int code, const char* msg) {​
(void)callUserId;​
(void)state;​
(void)code;​
(void)msg;​
}​
​
onGetAudioInjectionState​
描述:查询音频注入状态的结果回调。​
​
参数​
说明​
state​
音频注入状态,取值:​
  • true:开启​
  • false:关闭​
code​
错误码,取值:​
  • 0:成功​
  • <0:失败​
msg​
错误信息​
​
语法:​
​
void onGetAudioInjectionState(bool state, int code, const char* msg) {​
(void)state;​
(void)code;​
(void)msg;​
}​
​
onVideoInjectionStateChanged​
描述:视频注入状态改变的回调。​
​
参数​
说明​
callUserId​
改变视频注入状态的用户 ID​
state​
视频注入状态,取值:​
  • true:开启​
  • false:关闭​
code​
错误码,取值:​
  • 0:成功​
  • <0:失败​
msg​
错误信息​
​
语法:​
​
void onVideoInjectionStateChanged(const char* callUserId, bool state, int code, const char* msg) {​
(void)callUserId;​
(void)state;​
(void)code;​
(void)msg;​
}​
​
onGetVideoInjectionState​
描述:查询视频注入状态结果回调​
​
参数​
说明​
state​
视频注入状态,取值:​
  • true:开启​
  • false:关闭​
code​
错误码,取值:​
  • 0:成功​
  • <0:失败​
msg​
错误信息​
​
语法:​
​
void onGetVideoInjectionState(bool state, int code, const char* msg) {​
(void)state;​
(void)code;​
(void)msg;​
}​
​
onKeyboardTypeChanged​
描述:键盘类型改变的回调,调用 setKeyboardType 接口切换键盘类型后返回。​
语法:​
​
void onKeyboardTypeChanged(int code, vecommon::KeyboardType type) {​
(void)code;​
(void)type;​
}​
​
​
参数​
说明​
code​
错误码,取值:​
  • 0:成功​
  • <0:失败​
  • 1000:不允许设置​
type​
当前使用的键盘类型。参看 KeyboardType​
​
onGetKeyboardTypeResult​
描述:查询键盘类型的结果回调,通过 getKeyboardType 接口触发。​
语法:​
​
void onGetKeyboardTypeResult(int code, vecommon::KeyboardType type) {​
(void)code;​
(void)type;​
}​
​
​
参数​
说明​
code​
错误码,取值:​
  • 0:成功​
  • <0:失败​
  • 1000:不允许设置​
type​
当前使用的键盘类型。参看 KeyboardType​
​
onControlStateChanged​
描述:设置操控权并且成功的结果回调。​
调用 enableControl 设置操控权成功后,房间内的所有用户都会收到本回调通知。​
语法:​
​
void onControlStateChanged(const vecommon::ControlState& state) {​
(void)state;​
}​
​
​
参数​
说明​
state​
操控权状态相关信息,参看 ControlState 结构体说明。​
​
onEnableControlResult​
描述:设置操控权的结果回调。​
调用 enableControl 设置操控权成功后,接口调用者会收到本回调通知。​
语法:​
​
void onEnableControlResult(int code, const vecommon::ControlState& state, const std::string& msg) {​
(void)code;​
(void)state;​
(void)msg;​
}​
​
​
参数​
说明​
code​
错误码。​
  • 0:成功;​
  • <0:失败。​
state​
操控权状态。参看 ControlState 结构体说明。​
msg​
错误信息。​
​
onHasControlResult​
描述:查询某个用户操控权的结果回调。​
调用 hasControl 成功后,查询结果将通过本回调返回。​
语法:​
​
void onHasControlResult(int code, const vecommon::ControlState& state, const std::string& msg) {​
(void)code;​
(void)state;​
(void)msg;​
}​
​
​
参数​
说明​
code​
错误码。​
  • 0:成功;​
  • <0:失败。​
state​
操控权状态。参看 ControlState 结构体说明。​
msg​
错误信息。​
​
onAllControlsResult​
描述:查询所有用户操控权的结果回调。​
调用 getAllControls 成功后,查询结果将通过本回调返回。​
语法:​
​
void onAllControlsResult(int code, const std::vector<vecommon::ControlState>& states, const std::string& msg) {​
(void)code;​
(void)states;​
(void)msg;​
}​
​
​
参数​
说明​
code​
错误码。​
  • 0:成功;​
  • <0:失败。​
states​
操控权状态列表。参看 ControlState 结构体说明。​
msg​
错误信息。​
​
onReceiveChannelMessage​
描述:接收到通道消息的回调。​
语法:​
​
virtual void onReceiveChannelMessage(const vecommon::ChannelMessage message) {​
(void)message;​
}​
​
​
参数​
说明​
message​
消息实体,参看 ChannelMessage 说明。​
​
onSendChannelMessageResult​
描述:发送通道消息的结果回调。​
语法:​
​
virtual void onSendChannelMessageResult(bool success, const std::string& msgId) {​
(void)success;​
(void)msgId;​
}​
​
​
参数​
说明​
success​
消息发送结果。​
  • true:成功;​
  • false:失败。​
msgId​
消息 ID。​
​
onMessageChannelStateChanged​
描述:消息通道状态改变时的回调。​
语法:​
​
virtual void onMessageChannelStateChanged(const std::string& remoteUid, const vecommon::MessageChannelState state) {​
(void)remoteUid;​
(void)state;​
}​
​
​
参数​
说明​
remoteUid​
发生状态改变的通道 ID。​
state​
通道状态,参看 MessageChannelState 说明。​
​
onMessageChannelError​
描述:消息通道发生错误时的回调。​
语法:​
​
virtual void onMessageChannelError(int code, const std::string& msg) {​
(void)code;​
(void)msg;​
}​
​
​
参数​
说明​
code​
错误码。​
msg​
错误信息。​
​
onRecordingStatus​
描述:屏幕录制结果回调。​
语法:​
​
virtual void onRecordingStatus(int status, const std::string& savePath, const std::string& downloadUrl, const std::string& msg) {​
(void)status;​
(void)savePath;​
(void)downloadUrl;​
(void)msg;​
}​
​
​
参数​
说明​
status​
录屏任务状态,包含以下取值:​
  • 0:录制成功,正常结束,上传录屏文件到对象存储成功,返回录像文件保存路;​
  • 1:录制成功,正常结束,录屏文件成功保存至云手机本地;​
  • 2:开始录制成功;​
  • 3:开始录制失败,重复请求开始录制;​
  • 4:结束录制失败,没有正在录制中的任务;​
  • 5:录制失败,云手机存储空间不足,已占用存储空间总量的 80%;​
  • 6:录制结束,达到录制时限,返回录像文件保存路径;​
  • 7:开始录制失败,录制时长超过上限。​
savePath​
录屏文件在云手机实例中的保存路径。调用 startRecording 设置 saveOnPod 为 true,且 status 为 0、1、2 时返回。默认保存路径为 /sdcard/Pictures/Recordings/recording_yymmdd_[秒级时间戳].mp4。​
downloadUrl​
录屏文件的下载链接,status 为 0 时返回。​
msg​
提示信息。​
​
onVideoStreamProfileIdChanged​
描述:清晰度档位发生改变的回调。​
清晰度档位详情参看 云手机清晰度档位说明。​
语法:​
​
virtual void onVideoStreamProfileIdChanged(const std::string& callUserId, bool success, int from, int current) {​
(void)callUserId;​
(void)success;​
(void)from;​
(void)current;​
}​
​
​
参数​
说明​
callUserId​
设置视频流清晰度档位的用户 ID。​
success​
设置结果。​
  • true:成功;​
  • false:失败。​
from​
变化前的清晰度档位。​
current​
变化后当前的清晰度档位。​
​
onGetVideoStreamProfileIdResult​
描述:查询清晰度档位的结果回调。​
清晰度档位详情参看 云手机清晰度档位说明。​
语法:​
​
virtual void onGetVideoStreamProfileIdResult(bool success, int current) {​
(void)success;​
(void)current;​
}​
​
​
参数​
说明​
success​
查询结果。​
  • true:成功;​
  • false:失败。​
current​
当前的清晰度档位。​
​
onIdleTimeChanged​
描述:保活时长发生改变的回调。​
语法:​
​
virtual void onIdleTimeChanged(const std::string& callUserId, int code, int time) {​
(void)callUserId;​
(void)code;​
(void)time;​
}​
​
​
参数​
说明​
callUserId​
改变保活时长的用户 ID。​
code​
操作结果,取值:​
  • 0:成功。​
  • <0:失败。​
time​
保活时长。​
​
onGetIdleTimeResult​
描述:获取保活时长的结果回调。​
语法:​
​
virtual void onGetIdleTimeResult(int code, int time) {​
(void)code;​
(void)time;​
}​
​
​
参数​
说明​
code​
查询结果,取值:​
  • 0:成功。​
  • <0:失败。​
time​
保活时长。​
​
IExpireTimeListener​
描述:更新拉流 token 过期时间的监听器。​
​
class vecommon::IExpireTimeListener​
​
成员函数​
onUpdateExpireTimeOneStepResult​
描述:更新拉流 Token 过期时间的结果回调。​
语法:​
​
virtual void onUpdateExpireTimeOneStepResult(int result, std::vector<vecommon::ExpireTimeFailure>& failureList) {​
(void)result;​
(void)failureList;​
}​
​
​
参数​
说明​
result​
结果,取值:​
  • 0:成功。​
  • <0:失败。​
failureList​
更新失败的实例列表。参看 ExpireTimeFailure​
​
onWarning​
描述:SDK 内部产生警告信息回调。​
语法:​
​
void onWarning(int code) {​
(void)code;​
}​
​
​
参数​
说明​
code​
SDK 内部产生的警告信息,具体错误码,见 警告码及说明​
msg​
返回 code 的对应描述信息​
​
onError​
描述:SDK 内部产生错误信息回调,产生错误会调用 stop() 停止从云机拉流。​
语法:​
​
void onError(int code, const std::string msg) {​
(void)code;​
(void)msg;​
}​
​
​
参数​
说明​
code​
SDK 内部产生的错误码,具体错误码,见 错误码及说明​
msg​
返回 code 的对应描述信息​
​
onMicInnerRecordStateChanged​
描述:云手机播放音频的内录(指将云手机播放的音频作为云端应用的麦克风输入)状态变化回调,连接建立后会同步一次当前状态。​
语法:​
​
class MicInnerRecordStateListener {​
public:​
virtual ~MicInnerRecordStateListener() = default;​
​
virtual void onMicInnerRecordStateChanged(​
const vecommon::PodMicInnerRecordState& state) = 0;​
};​
​
​
参数​
说明​
state​
当前麦克风内录状态,取值参见 PodMicInnerRecordState。​
​
PodMicInnerRecordState​
描述:麦克风内录状态类,定义内录功能的开关状态常量。​
语法:​
​
class PodMicInnerRecordState final {​
public:​
static constexpr int STATE_ON = 1;​
static constexpr int STATE_OFF = 0;​
static constexpr int STATE_SETTINGS_CONTROL = -1;​
​
explicit PodMicInnerRecordState(int state)​
: state(state) {​
}​
​
int state;​
};​
​
​
参数​
说明​
STATE_ON​
麦克风内录已开启,取值为 1。​
STATE_OFF​
麦克风内录已关闭,取值为 0。​
STATE_SETTINGS_CONTROL​
内录开关由系统设置接管,SDK 无法控制,取值为 -1。​
state​
当前麦克风内录状态,取值为 STATE_ON、STATE_OFF、STATE_SETTINGS_CONTROL。​
​
​
最近更新时间:2026.09.24 17:47:45
这个页面对您有帮助吗?
有用
有用
无用
无用