概览JCClientJCClientCallbackJCMediaDeviceJCMediaDeviceCallbackJCCallJCCallCallbackJCMediaChannelJCMediaChannelCallback错误码

• JCClient 类用于初始化sdk以及登录 Juphoon Cloud 平台
• JCClientCallback 用于回调登录相关事件
• JCMediaDevice 类用于管理媒体设备
• JCMediaDeviceCallback 用于回调媒体设备相关事件
• JCCall 类用于管理一对一通话
• JCCallCallback 用于回调一对一通话相关事件
• JCMediaChannel 类用于管理多方通话
• JCMediaChannelCallback 用于回调多方通话相关事件
• 错误码

登录管理

方法	描述
create	创建 JCClient 对象
destroy	销毁 JCClient 对象
login	登录 Juphoon Cloud 平台
logout	登出 Juphoon Cloud 平台
appkey	获取Appkey
displayName	设置/获取昵称
userId	获得用户标识
state	获取当前状态
createParam	获取创建参数
loginParam	获取登录参数
sendOnlineMessage	发送在线消息

登录事件

事件	描述
onLogin	登录结果回调
onLogout	登出回调
onClientStateChange	登录状态变化通知
onOnlineMessageSend	在线消息发送结果通知
onOnlineMessageReceive	收到在线消息通知

设备管理

方法	描述
create	创建 JCMediaDevice 对象
destroy	销毁 JCMediaDevice 对象
startCameraVideo	开始自身视频渲染
startVideo	开始其他端的视频渲染
stopVideo	停止视频渲染
audioStart	音频是否已打开
startAudio	启动音频
stopAudio	停止音频
startCamer	开启摄像头
stopCamera	关闭摄像头
switchCamera	切换摄像头
switchCamera2	切换摄像头(指定摄像头)
setCameraProperty	设置摄像头采集属性
setScreenCaptureProperty	设置屏幕共享采集属性
startVideoFile	开启视频文件作为视频输入源
setVideoFileFrame	逐帧采集视频画面
stopVideoFile	关闭逐帧采集画面
cameraOpen	摄像头是否已打开
camera	获取当前的摄像头
cameras	获取摄像头列表
videoFileOpen	文件视频源是否已开启
videoFileId	获取文件视频源渲染id
localVideoAngle	设置/获取本端视频画面渲染角度
remoteVideoAngle	设置/获取远端视频画面渲染角度
isSpeakerOn	扬声器是否已打开
enableSpeaker	开启关闭扬声器
getAudioRouteType	获得当前音频类型
registerAudioFrameCallback	设置语音观测器对象
registerVideoFrameCallback	设置视频观测器对象
inputCustomAudioData	将音频输入数据输入到媒体层
getAudioOutputData	获取音频输出数据
JCMediaDevice#enableScreenCapture:appGroupId:preferredExtension:	开启/关闭屏幕采集
JCMediaDevice#getOutputVolume	获取音频播放音量
JCMediaDevice#getInputVolume	获取音频采集音量
opusToAacStart	开始opus流转aac文件存储
opusToAacInput	opus流转aac文件
addVolumeCallback	添加音量上报回调
removeVolumeCallback	删除音量上报回调

设备事件

事件	描述
onCameraUpdate	摄像头变化
onAudioOutputTypeChange	音频输出类型变化
onRenderReceived	收到第一帧数据
onRenderStart	渲染开始
onAudioInputFrame	获得采集的音频
onAudioOutputFrame	获得播放的音频
onVideoCaptureFrame	获得采集的视频
onVideoRenderFrame	获得播放的视频
inputVolume	音频采集数据音量
outputVolumeAvg: outputVolume	音频播放数据音量

屏幕采集

事件	描述
JCBroadcastSampleHandler#broadcastStartedWithAppGroupId:initWithSampleHandler:	开启屏幕共享
withType:	屏幕采集开始
JCBroadcastSampleHandler#broadcastFinished	插件停止
JCBroadcastSampleHandler#broadcastResumed	插件重启
JCBroadcastSampleHandler#broadcastPaused	插件暂停

一对一通话管理

方法	描述
create	创建 JCCall 对象
destroy	销毁 JCCall 对象
call	发起一对一呼叫
term	挂断
answer	接听
mute	静音
hold	呼叫保持
audioRecord	语音通话录音
videoRecord	视频通话录制
becomeActive	切换活跃通话
enableUploadVideoStream	开启关闭视频流发送
callItems	获得通话对象列表
getActiveCallItem	获得当前活跃的通话
sendMessage	通过通话建立的通道发送数据
getStatistics	获得当前通话统计信息
mediaConfig	更新/获取媒体参数
sendDtmf	发送DTMF信息
setMicScale	设置麦克风输入声音线性放大值
setAgcTarge	设置发送端agc

一对一通话事件

事件	描述
onCallItemAdd	新增通话回调
onCallItemRemove	移除通话回调
onCallItemUpdate	通话状态更新回调
onMessageReceive	通话中收到消息的回调
onMissedCallItem	上报服务器拉取的未接来电
onDtmfReceived	通话中收到DTMF回调
onEarlyMediaReceived	收到早期媒体的回调
onSipRingInfoReceived	收到sip振铃信息

多方通话管理

方法	描述
create	创建 JCMediaChannel 对象
destroy	销毁 JCMediaChannel 对象
channelUri	获得频道 Uri
channelId	获得频道标识
confId	获得confId
password	获得频道密码
channelNumber	获得频道号
title	返回频道标题
state	返回当前在频道中的状态
participants	获得所有频道中的成员
uploadLocalAudio	获取本地音频数据是否在上传
uploadLocalVideo	获取本地视频数据是否在上传
audioOutput	获取音频是否输出
screenRenderId	获取屏幕共享渲染标识
screenUserId	获取开启屏幕共享的用户标识
recordState	获取视频录制状态
cdnState	获得cdn推流状态
query	查询频道相关信息
join	加入频道
leave	离开频道
stop	关闭频道
enableUploadAudioStream	开启关闭发送本地音频流
enableUploadVideoStream	开启关闭发送本地视频流
enableAudioOutput	开启关闭音频输出
requestVideo	请求频道中其他用户的视频流
requestScreenVideo	请求频道成员屏幕共享的视频流
enableCdn	开关Cdn推流
enableRecord	开关视频录制
enableScreenShare	开关屏幕分享(应用内)
JCMediaChannel#enableScreenShare:appGroupId:preferredExtension:	开关屏幕分享(全局)
getParticipant	获取频道成员
getStatistics	获取统计信息
setCustomProperty	设置频道自定义属性
getCustomProperty	获取频道自定义属性
sendMessage	发送消息
sendCommand	发送指令
inviteSipUser	邀请Sip用户
setCustomRole	设置自定义角色
getCustomRole	获得自定义角色
setCustomState	设置自定义状态
getCustomState	获得自定义状态
kick	将成员踢出会议
sendCommandToDelivery	发送命令给推流或录制器
enableSelfVideoRatio	设置自身视频宽高比
startScreenShareVideo	启动频道成员的屏幕分享视频渲染
stopScreenShareVideo	停止屏幕分享视频渲染
selfParticipant	获得自身 JCMediaChannelParticipant 对象
maxResolution	获得频道最大分辨率
subscribeParticipantAudio	订阅或取消订阅指定用户的声音

多方通话事件

事件	描述
onMediaChannelStateChange	自身状态变化回调
onMediaChannelPropertyChange	属性变化回调
onJoin	加入频道结果回调
onLeave	离开频道结果回调
onStop	解散频道结果回调
onQuery	查询频道信息结果回调
onParticipantJoin	新成员加入回调
onParticipantLeft	成员离开回调
onParticipantUpdate	成员更新回调
onMessageReceive	接收频道消息的回调
onInviteSipUserResult	邀请Sip用户操作结果回调
onParticipantVolumeChange	成员声音变化

画中画方法

方法	描述
create	使用媒体设备与代理创建 PiP。
create:call	绑定媒体设备与通话实例。
create:mediaChannel	绑定媒体设备与会议实例。
create:call:mediaChannel	同时绑定媒体设备、通话与会议。
destroy	销毁 PiP 实例并释放资源。
startPictureInPicture	启动画中画。
stopPictureInPicture	停止画中画。
isPictureInPictureActive	查询 PiP 是否激活。
attach	注册帧回调并挂载 DisplayLayer。
detach	注销帧回调并卸载 DisplayLayer。

画中画事件

事件	描述
pipHandlerDidStart	PiP 启动成功回调。
pipHandler:didFailToStart	PiP 启动失败回调。
pipHandlerDidStop	PiP 结束回调。