- JCClient 用于初始化sdk以及登录 Juphoon Cloud 平台
- JCClientCallback 用于回调登录相关事件
- JCMediaDevice 用于管理设备
- JCMediaDeviceCallback 用于回调设备相关事件
- JCCall 用于管理一对一通话
- JCCallCallback 用于回调一对一通话相关事件
- JCMediaChannel 用于管理多方通话
- JCMediaChannelCallback 用于回调多方通话相关事件
- 错误码
登录管理
| 方法 | 描述 |
|---|---|
| create | 创建 JCClient 对象 |
| destroy | 销毁 JCClient 对象 |
| getAppkey | 获取Appkey |
| setForeground | 设置是否为前台 |
| getState | 获取当前状态 |
| login | 登录 Juphoon Cloud 平台 |
| logout | 登出 Juphoon Cloud 平台 |
登录事件
| 事件 | 描述 |
|---|---|
| onLogin | 登录结果回调 |
| onLogout | 登出回调 |
| onClientStateChange | 登录状态变化通知 |
账号管理
| 方法 | 描述 |
|---|---|
| setDisplayName | 设置昵称 |
| getDisplayName | 获取昵称 |
| getCreateParam | 获取创建参数 |
| getLoginParam | 获取登录参数 |
| getUserId | 获得用户标识 |
在线消息
| 方法 | 描述 |
|---|---|
| sendOnlineMessage | 发送在线消息 |
在线消息事件
| 方法 | 描述 |
|---|---|
| onOnlineMessageSendResult | 在线消息发送结果 |
| onOnlineMessageReceive | 收到在线消息 |
设备管理
| 事件 | 描述 |
|---|---|
| create | 创建 JCMediaDevice 对象 |
| destroy | 销毁 JCMediaDevice 对象 |
音频管理
| 方法 | 描述 |
|---|---|
| isSpeakerOn | 扬声器是否已打开 |
| isAudioStart | 音频是否已打开 |
| startAudio | 启动音频 |
| stopAudio | 停止音频 |
| enableSpeaker | 开启关闭扬声器 |
| getAudioRouteType | 音频路由类型 |
| setAudioFrameCallback | 设置语音观测器对象 |
| inputCustomAudioData | 将音频输入数据输入到媒体层 |
| getAudioOutputData | 获取音频输出数据 |
| getOutputVolume | 获取音频播放音量 |
| getInputVolume | 获取音频采集音量 |
音频事件
| 事件 | 描述 |
|---|---|
| onAudioOutputTypeChange | 音频输出类型变化 |
| onAudioInputFrame | 获得采集的音频 |
| onAudioOutputFrame | 获得播放的音频 |
| onAudioError | 音频设备报错 |
| onAudioResume | 音频设备恢复 |
| onEarlyMediaReceived | 收到早期媒体的回调 |
| onSipRingInfoReceived | 收到早期媒体的回调收到sip振铃信息 |
视频管理
| 方法 | 描述 |
|---|---|
| isCameraOpen | 摄像头是否已打开 |
| getCamera | 获取当前的摄像头 |
| getCameras | 获取摄像头列表 |
| startCameraVideo | 开始自身视频渲染 |
| startVideo | 开始其他端的视频渲染 |
| stopVideo | 停止视频渲染 |
| startCamera | 开启摄像头 |
| stopCamera | 关闭摄像头 |
| switchCamera | 切换摄像头 |
| switchCamera2 | 切换摄像头(指定摄像头) |
| setCameraProperty | 设置摄像头采集属性 |
| setScreenCaptureProperty | 设置屏幕共享采集属性 |
| getCameraType | 获得摄像头类型 |
| isVideoFileOpen | 文件视频源是否已开启 |
| getVideoFileId | 获取文件视频源渲染id |
| startVideoFile | 开启视频文件作为视频输入源 |
| setVideoFileFrame | 逐帧采集视频画面 |
| stopVideoFile | 关闭逐帧采集画面 |
| setVideoAngle | 设置视频窗体角度 |
| getVideoAngle | 获取视频窗体角度 |
| setVideoFrameCallback | 设置视频观测器对象 |
视频事件
| 事件 | 描述 |
|---|---|
| onCameraUpdate | 摄像头变化 |
| onRenderReceived | 收到第一帧数据 |
| onRenderStart | 渲染开始 |
| onVideoCaptureFrame | 获得采集的视频 |
| onVideoRenderFrame | 获得播放的视频 |
一对一通话管理
| 方法 | 描述 |
|---|---|
| create | 创建 JCCall 对象 |
| destroy | 销毁 JCCall 对象 |
| call | 发起一对一呼叫 |
| term | 挂断 |
| answer | 接听 |
| mute | 静音 |
| muteSpeaker | 音频输出静音 |
| muteMicrophone | 音频输入静音 |
| setMicScale | 麦克风声音放大 |
| hold | 呼叫保持 |
| becomeActive | 切换活跃通话 |
| getCallItems | 获得通话对象列表 |
| getActiveCallItem | 获得当前活跃的通话 |
| getStatistics | 获得当前通话统计信息 |
一对一通话事件
| 事件 | 描述 |
|---|---|
| onCallItemAdd | 新增通话回调 |
| onCallItemRemove | 移除通话回调 |
| onCallItemUpdate | 通话状态更新回调 |
| onMissedCallItem | 上报服务器拉取的未接来电 |
通话录音管理
| 方法 | 描述 |
|---|---|
| audioRecord | 语音通话录音 |
| videoRecord | 视频通话录制 |
DTMF
| 方法 | 描述 |
|---|---|
| sendDtmf | 发送DTMF信息 |
DTMF事件
| 方法 | 描述 |
|---|---|
| onDtmfReceived | 通话中收到DTMF回调 |
通话中消息管理
| 方法 | 描述 |
|---|---|
| sendMessage | 通过通话建立的通道发送数据 |
通话中消息事件
| 方法 | 描述 |
|---|---|
| onMessageReceive | 通话中收到消息的回调 |
通话媒体参数管理
| 方法 | 描述 |
|---|---|
| updateMediaConfig | 更新媒体参数 |
| getMediaConfig | 获得当前的媒体参数 |
通话视频流管理
| 方法 | 描述 |
|---|---|
| enableUploadVideoStream | 开启关闭视频流发送 |
频道管理
| 方法 | 描述 |
|---|---|
| create | 创建 JCMediaChannel 对象 |
| destroy | 销毁 JCMediaChannel 对象 |
| getChannelUri | 获得频道 Uri |
| getChannelId | 获得频道标识 |
| getPassword | 获得频道密码 |
| getChannelNumber | 获得频道号 |
| getTitle | 返回频道标题 |
| getState | 返回当前在频道中的状态 |
| query | 查询频道相关信息 |
| join | 加入频道 |
| leave | 离开频道 |
| stop | 关闭频道 |
| setCustomProperty | 设置频道自定义属性 |
| getCustomProperty | 获取自定义频道属性 |
| setCustomRole | 设置自定义角色 |
| getCustomRole | 获得自定义角色 |
| setCustomState | 设置自定义状态 |
| getCustomState | 获得自定义状态 |
| getSelfParticipant | 获得自身 JCMediaChannelParticipant 对象 |
频道事件
| 事件 | 描述 |
|---|---|
| onMediaChannelStateChange | 自身状态变化回调 |
| onMediaChannelPropertyChange | 属性变化回调 |
| onJoin | 加入频道结果回调 |
| onLeave | 离开频道结果回调 |
| onStop | 解散频道结果回调 |
| onQuery | 查询频道信息结果回调 |
频道音视频管理
| 方法 | 描述 |
|---|---|
| getAudioOutput | 获取音频是否输出 |
| enableUploadAudioStream | 开启关闭发送本地音频流 |
| enableUploadVideoStream | 开启关闭发送本地视频流 |
| enableAudioOutput | 开启关闭音频输出 |
| requestVideo | 请求频道中其他用户的视频流 |
| getStatistics | 获取统计信息 |
| enableSelfVideoRatio | 设置自身视频宽高比 |
| getMaxResolution | 获得频道最大分辨率 |
成员管理
| 事件 | 描述 |
|---|---|
| getParticipants | 获得所有频道中的成员 |
| getParticipant | 获取频道成员 |
| inviteSipUser | 邀请Sip用户 |
| kick | 将成员踢出会议 |
| subscribeParticipantAudio | 订阅或取消订阅指定用户的声音 |
成员事件
| 事件 | 描述 |
|---|---|
| onParticipantJoin | 新成员加入回调 |
| onParticipantLeft | 成员离开回调 |
| onParticipantUpdate | 成员更新回调 |
| onInviteSipUserResult | 邀请Sip用户操作结果回调 |
| onParticipantVolumeChange | 成员声音变化 |
Cdn推流
| 事件 | 描述 |
|---|---|
| enableCdn | 开关Cdn推流 |
| getCdnState | 获得cdn推流状态 |
服务器录制
| 事件 | 描述 |
|---|---|
| enableRecord | 开关视频录制 |
| getRecordState | 获取视频录制状态 |
音频数据上传
| 事件 | 描述 |
|---|---|
| getUploadLocalAudio | 获取本地音频数据是否在上传 |
视频数据上传
| 事件 | 描述 |
|---|---|
| getUploadLocalVideo | 获取本地视频数据是否在上传 |
频道消息管理
| 事件 | 描述 |
|---|---|
| sendMessage | 发送消息 |
| sendCommand | 发送指令 |
| sendCommandToDelivery | 发送命令给推流或录制器 |
频道消息事件
| 事件 | 描述 |
|---|---|
| onMessageReceive | 接收频道消息的回调 |
屏幕共享
| 事件 | 描述 |
|---|---|
| requestScreenVideo | 请求屏幕共享的视频流 |
| enableScreenShare | 开关屏幕分享 |
| getScreenRenderId | 获取屏幕共享渲染标识 |
| getScreenUserId | 获取开启屏幕共享的用户标识 |
| startScreenShareVideo | 启动屏幕共享视频渲染 |
| stopScreenShareVideo | 停止屏幕共享视频渲染 |