iOS

# 概览

视频通话插件 Android 侧公开接口总览,建议按“通用能力 -> 业务管理类 -> 参数与配置对象 -> 事件回调 -> 集成文档”的顺序阅读。

# 快速导航

# 通用能力

类型 描述
JCCCommonManager (opens new window) 通用管理能力定义,包含初始化、登录、登出、消息、文件上传、版本与窗口管理等公共接口
JCCCommonCallback (opens new window) 通用回调事件定义,业务模块回调均基于该接口扩展
JCCCommonCustomConfig (opens new window) 通用定制化配置基类
JCCConstants (opens new window) 状态码、枚举值和常量定义入口
JCCVersion (opens new window) SDK 与底层库版本信息对象

# 参数与配置对象

# 访客模块

类型 描述
JCCLoginParam (opens new window) 登录参数
JCCGuestCallParam (opens new window) 发起访客呼叫参数
JCCGuestCustomConfig (opens new window) 访客模块定制化配置
JCCIncomingConfig (opens new window) 来电场景配置
JCCWaitingConfig (opens new window) 等待界面配置
JCCTalkingConfig (opens new window) 通话界面配置
JCCInviter (opens new window) 邀请方信息对象
JCCGroupItem (opens new window) 业务组信息对象
JCCUploadFileParam (opens new window) 文件上传参数
JCCIBaseView (opens new window) 业务界面基础视图接口

# 多方通话模块

类型 描述
JCCRoomJoinParam (opens new window) 加入房间参数
JCCRoomQueryInfo (opens new window) 房间查询结果对象
JCCRoomCustomConfig (opens new window) 多方通话模块定制化配置

# 多方通话 2.0 模块

类型 描述
JCallJoinParam (opens new window) 加入通话参数
JCallAcceptParam (opens new window) 接受邀请参数
JCallExtraParam (opens new window) 扩展呼叫参数
JCallCustomConfig (opens new window) 多方通话 2.0 模块定制化配置

# 访客插件接口管理

方法 描述
init 初始化,需要在 Application 的 onCreate 方法调用
login 初始化并登录
logout 登出并销毁
getClientLoginState 获取当前登录状态
sendOnlineMessage 发送在线消息
sendMessageInCall 透明通道发送消息给某个成员
uploadFile 文件上传
getCallId 获取通话 ID
setCustomConfig 设置定制配置参数
setVideoAngle 设置视频旋转角度
getVersion 获取 SDK 和底层库的版本号信息
queryAllGroups 查询业务组列表
call 发起呼叫
answer 接听来电
term 结束通话
setCallParam 设置呼叫参数
showTalkingView 启动通话界面
showSignView 通话中唤起电子签名
addCallback 订阅回调
removeCallback 取消订阅回调
miniTalkingWindow 最小化通话窗口
restoreTalkingWindow 恢复通话窗口
switchFocusVideoView 切换焦点视频
enableRemoteCollaboration 开启/关闭远程协作

# 访客事件

事件 描述
onLogin 登录结果回调
onLogout 登出结果回调
onOnlineMessageSendResult 发送在线消息结果
onOnlineMessageReceived 收到在线消息
onMessageInCallReceived 接收通话中消息的回调
onUploadFileResult 文件上传成功回调
onUploadFileError 文件上传失败回调
onError 上报事件回调
onViewEvent UI 事件通知
onGetAllGroups 查询业务组号回调
onCallStateChanged 通话状态改变回调
onSignRequestComplete 电子签名文件保存回调

# 多方通话插件接口管理

方法 描述
init 初始化,需要在 Application 的 onCreate 方法调用
login 初始化并登录
logout 登出并销毁
getClientLoginState 获取当前登录状态
sendOnlineMessage 发送在线消息
sendMessageInCall 透明通道发送消息给某个成员
uploadFile 文件上传
getCallId 获取当前通话 ID
setCustomConfig 设置定制配置参数
setVideoAngle 设置视频旋转角度
getVersion 获取 SDK 和底层库的版本号信息
query 查询房间相关信息
join 加入房间
leave 离开房间
addCallback 订阅回调
removeCallback 取消订阅回调
miniTalkingWindow 最小化通话窗口
restoreTalkingWindow 恢复通话窗口
switchFocusVideoView 切换焦点视频
enableRemoteCollaboration 开启/关闭远程协作

# 多方通话事件

事件 描述
onLogin 登录结果回调
onLogout 登出结果回调
onOnlineMessageSendResult 发送在线消息结果
onOnlineMessageReceived 收到在线消息
onMessageInCallReceived 收到通话中消息的回调
onUploadFileResult 文件上传成功回调
onUploadFileError 文件上传失败回调
onError 上报事件回调
onViewEvent UI 事件通知
onQuery 查询房间信息结果回调
onJoin 加入房间结果回调
onLeave 离开房间结果回调
onRoomStateChanged 自身在房间中的状态变化回调

# 多方通话 2.0 插件接口管理

方法 描述
init 初始化,需要在 Application 的 onCreate 方法调用
login 初始化并登录
logout 登出并销毁
getClientLoginState 获取当前登录状态
sendOnlineMessage 发送在线消息
sendMessageInCall 透明通道发送消息给某个成员
uploadFile 文件上传
getCallId 获取当前通话 ID
setCustomConfig 设置定制配置参数
setVideoAngle 设置视频旋转角度
miniTalkingWindow 最小化通话窗口
restoreTalkingWindow 恢复通话窗口
switchFocusVideoView 切换焦点视频
enableRemoteCollaboration 开启/关闭远程协作
getVersion 获取 SDK 和底层库的版本号信息
join 加入通话
leave 离开通话
getCallState 获取自己当前在房间中的状态
invite 邀请其他成员加入通话
cancelInvite 取消邀请
acceptInvite 接受邀请,详细参数见 JCallAcceptParam (opens new window)
rejectInvite 拒绝邀请
addCallback 订阅回调
removeCallback 取消订阅回调

# 多方通话 2.0 事件

事件 描述
onLogin 登录结果回调
onLogout 登出结果回调
onOnlineMessageSendResult 发送在线消息结果
onOnlineMessageReceived 收到在线消息
onMessageInCallReceived 收到通话中消息的回调
onUploadFileResult 文件上传成功回调
onUploadFileError 文件上传失败回调
onError 上报事件回调
onViewEvent UI 事件通知
onJoin 加入通话结果回调
onLeave 离开通话结果回调
onCallPropertyChanged 通话属性改变,重点关注屏幕共享
onInviteResult 邀请结果回调
onCancelInviteResult 取消邀请结果回调
onAcceptInviteResult 接受邀请结果回调
onRejectInviteResult 拒绝邀请结果回调
onInviteReceived 收到邀请通知
onInviteCanceled 对方取消邀请通知
onInviteAccepted 对方接受邀请通知
onInviteRejected 对方拒绝邀请通知