iOS

# JRTCSDK-WeChat(视频客服) v2401.0

# 概览 (opens new window)

# 登录登出管理 (opens new window)

方法 描述
create (opens new window) 创建 JRTCClient (opens new window) 对象
destroy (opens new window) 销毁 JRTCClient (opens new window) 对象
login (opens new window) 登录 Juphoon RTC 平台
logout (opens new window) 登出 Juphoon RTC 平台
getUserId (opens new window) 获取用户ID
getState (opens new window) 获取当前登录状态
getDisplayName (opens new window) 获取用户昵称
setDisplayName (opens new window) 设置用户昵称
getServer (opens new window) 获取接入服务器地址
setServer (opens new window) 设置接入服务器地址
getAppKey (opens new window) 获取 Appkey
setAppKey (opens new window) 设置 Appkey
getAppName (opens new window) 获取应用名称
setAppName (opens new window) 设置应用名称
sendOnlineMessage (opens new window) 发送在线消息

# 登录登出事件 (opens new window)

事件 描述
onLogin (opens new window) 登录结果回调
onLogout (opens new window) 登出回调
onClientStateChanged (opens new window) 登录状态变化通知
onSDKEvent (opens new window) 上报事件回调
onOnlineMessageSendResult (opens new window) 在线消息发送结果回调
onOnlineMessageReceived (opens new window) 收到在线消息回调

# 设备管理 (opens new window)

方法 描述
create (opens new window) 创建 JRTCMediaDevice (opens new window) 对象
destroy (opens new window) 销毁 JRTCMediaDevice (opens new window) 对象
startCameraVideo (opens new window) 开始本端视频渲染
startVideo (opens new window) 开始远端视频渲染
stopVideo (opens new window) 停止视频渲染
stopAllMedia (opens new window) 关闭所有媒体资源,包括远端和本端音视频
startAudioOutput (opens new window) 打开音频输出
stopAudioOutput (opens new window) 关闭音频输出
switchCamera (opens new window) 切换摄像头/切换到指定摄像头
isCameraOpen (opens new window) 摄像头是否打开
getCurrentCamera (opens new window) 获取当前摄像头
getCameras (opens new window) 获取摄像头列表
isAudioStart (opens new window) 音频设备是否打开
setCameraProperty (opens new window) 设置摄像头采集属性

# 设备事件 (opens new window)

事件 描述
onCameraUpdate (opens new window) 摄像头变化回调
onAudioInputUpdate (opens new window) 输入音频变化回调

# 视频客服访客管理 (opens new window)

方法 描述
create (opens new window) 创建 JRTCGuest (opens new window) 对象
destroy (opens new window) 销毁 JRTCGuest (opens new window) 对象
getCallState (opens new window) 获取当前通话状态
getCallType (opens new window) 获取当前通话类型
getHoldState (opens new window) 获取当前通话保持状态
isOnewayVideo (opens new window) 获取单向视频状态
isMainGuest (opens new window) 是否主访客
getMainAgentParticipant (opens new window) 获取主座席成员
getAgentParticipants (opens new window) 获取座席成员列表
getSelfParticipant (opens new window) 获取自己对象
getParticipants (opens new window) 获取所有成员
getSerialNumber (opens new window) 获取服务唯一标识
getCallId (opens new window) 获取通话唯一标识
getShareStreamId (opens new window) 获取屏幕共享的视频流ID
getShareUserId (opens new window) 获取发起屏幕共享者的用户ID
queryAllGroups (opens new window) 获取当前业务组列表
call (opens new window) 呼叫指定业务
oneToOneCall (opens new window) 呼叫指定座席
term (opens new window) 结束通话
requestUrgent (opens new window) 请求加急
sendMessage (opens new window) 发送消息,消息内容不能大于4K
sendNotifyMessage (opens new window) 发送事件通知消息
enableUploadAudioStream (opens new window) 开启/关闭发送本地音频流
enableUploadVideoStream (opens new window) 开启/关闭发送本地视频流
setRatio (opens new window) 设置本端视频宽高比
getRequestSize (opens new window) 获取视频请求尺寸
setRequestSize (opens new window) 设置视频请求尺寸
requestVideo (opens new window) 订阅通话中其他成员的视频流
unRequestVideo (opens new window) 取消订阅通话中其他成员的视频流
enableRemoteRecord (opens new window) 开启/关闭远程视频录制
getRemoteRecordState (opens new window) 获取远程视频录制状态
responseSignResult (opens new window) 响应座席签名请求

# 视频客服访客事件 (opens new window)

事件 描述
onGetAllGroups (opens new window) 查询业务组号结果回调
onCallStateChanged (opens new window) 通话状态改变回调
onCallQueueCount (opens new window) 当前排队人数上报回调
onCallPropertyChanged (opens new window) 通话属性改变回调
onMemberJoin (opens new window) 通话中有新成员加入回调
onMemberLeave (opens new window) 通话中有成员离开回调
onMemberUpdate (opens new window) 通话中成员属性更新回调
onHoldStateChanged (opens new window) 收到通话保持或取回的回调
onCallTypeChanged (opens new window) 音视频通话切换回调
onMessageReceived (opens new window) 收到消息回调
onSignRequest (opens new window) 收到签名请求回调
onOnewayVideoChanged (opens new window) 收到单向视频状态变化回调
onDeliveryAbort (opens new window) 录制异常回调
onNotifyMessageReceived (opens new window) 收到事件通知消息回调
onUrgentResultResponse (opens new window) 座席处理加急的结果回调