iOS

# JRTCSDK-HarmonyOS(视频客服) v2601.0

# 概览

# 登录登出管理

方法 描述
create (opens new window) 创建 JRTCClient (opens new window) 对象
destroy (opens new window) 销毁 JRTCClient (opens new window) 对象
setForeground (opens new window) 设置是否是前台
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) 设置应用名称
login (opens new window) 登录 Juphoon RTC 平台
logout (opens new window) 登出 Juphoon RTC 平台
sendOnlineMessage (opens new window) 发送在线消息
requestFileUploadInfo (opens new window) 获取文件上传或断点续传信息
completeFileUpload (opens new window) 文件上传完成确认
getUploadFileInfo (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) 收到在线消息回调
onRequestFileUploadInfoResponse (opens new window) 获取文件上传或断点续传信息响应
onCompleteFileUploadResponse (opens new window) 文件上传完成确认响应
onGetUploadFileInfoResponse (opens new window) 获取上传文件信息列表响应
onFileUploadPlatformNotify (opens new window) 文件上传到影像平台结果通知

# 设备管理

方法 描述
create (opens new window) 创建 JRTCMediaDevice (opens new window) 对象
destroy (opens new window) 销毁 JRTCMediaDevice (opens new window) 对象
isCameraOpen (opens new window) 检查摄像头是否打开
isSpeakerOn (opens new window) 检查扬声器是否开启
getCurrentCamera (opens new window) 获取当前使用的摄像头
getCameras (opens new window) 获取设备上所有可用的摄像头列表
isAudioInputStart (opens new window) 音频输入是否打开
isAudioOutputStart (opens new window) 音频输出是否打开
startAudio (opens new window) 启动音频
stopAudio (opens new window) 停止音频
startAudioInput (opens new window) 打开音频输入设备
stopAudioInput (opens new window) 关闭音频输入设备
startAudioOutput (opens new window) 打开音频输出设备
stopAudioOutput (opens new window) 关闭音频输出设备
startCamera (opens new window) 开启摄像头
stopCamera (opens new window) 关闭摄像头
switchCamera (opens new window) 切换摄像头
switchCameraBetweenFrontAndBack (opens new window) 切换摄像头,用于手机前置和后置摄像头的切换
specifyCamera (opens new window) 指定要开启的摄像头
specifyCameraAngle (opens new window) 指定摄像头采集角度
setCameraProperty (opens new window) 设置摄像头采集属性
setScreenCaptureProperty (opens new window) 获取摄像头类型
enableSpeaker (opens new window) 开启/关闭扬声器
isVideoFileOpen (opens new window) 是否开启文件视频源
getVideoFileId (opens new window) 获取文件视频源ID
startVideoFile (opens new window) 逐帧采集视频画面
setVideoFileFrame (opens new window) 获取文件视频源ID
stopVideoFile (opens new window) 关闭视频文件作为视频输入源
getAudioRouteType (opens new window) 获得当前音频输出通道类型
setVideoAngle (opens new window) 设置有效的发送镜头旋转角度和本地渲染旋转角度
getVideoAngle (opens new window) 获取视频窗体角度
setVideoScreenOrientation (opens new window) 设置屏幕转向
startVideoCaptureRecord (opens new window) 开启视频录制
stopVideoCaptureRecord (opens new window) 关闭视频录制
startAudioRecord (opens new window) 开启音频录制
stopAudioRecord (opens new window) 关闭音频录制
recoveryRecordFile (opens new window) 恢复录制文件
getScreenCaptureId (opens new window) 获取屏幕共享采集Id
enableScreenCapture (opens new window) 开启/关闭屏幕采集
snapshotWithStreamId (opens new window) 截图
setScreenCaptureData (opens new window) 设置屏幕采集数据为指定图片数据
resetScreenCaptureData (opens new window) 重置屏幕采集数据
startAudioTest (opens new window) 检测音频设备是否正常
stopAudioTest (opens new window) 停止检测音频设备
getMicLevel (opens new window) 获取当前本地音量级别
getSpkLevel (opens new window) 获取当前扬声器音量级别
getAnrNoiseLevel (opens new window) 获取当前噪声强度
getAnrNoiseRatio (opens new window) 获取当前信噪比强度
startRing (opens new window) 开始播放音频
stopRing (opens new window) 结束播放音频
enableAudioInputFromFile (opens new window) 开始/结束播放本地音频文件作为音频源输入
suspendAudioInputFromFile (opens new window) 暂停/继续播放语音文件作为音频源输入
setAec (opens new window) 设置开启自适应回声消除
setAgc (opens new window) 设置是否开启自动增益控制

# 设备事件

事件 描述
onAudioError (opens new window) 音频异常回调
onAudioRouteTypeChanged (opens new window) 音频输出通道变化回调
onCameraUpdate (opens new window) 摄像头变化回调
onVideoCaptureDidStart (opens new window) 视频采集开始回调
onRenderReceived (opens new window) 收到第一帧视频数据回调
onRenderStart (opens new window) 视频渲染开始回调
onRenderResized (opens new window) 视频宽高比例变化回调
onScreenSharePermissionResult (opens new window) 屏幕采集权限申请结果回调
onVideoError (opens new window) 视频异常回调
onSnapshotComplete (opens new window) 截图完成回调
onMemoryAvailable (opens new window) 设备剩余可用内存回调
onRingPlayFinish (opens new window) 铃声播放完成回调
onFileAudioInputDidFinish (opens new window) 本地文件音频源输入完成回调
onTessarEvent (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) 获取单向视频状态
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) 取消订阅通话中其他成员的视频流
requestScreenVideo (opens new window) 订阅通话中屏幕共享的视频流
unRequestScreenVideo (opens new window) 取消订阅通话中屏幕共享的视频流
createExtraStream (opens new window) 创建额外视频流
deleteExtraStream (opens new window) 删除额外视频流
requestExtraStreamVideo (opens new window) 订阅通话中其他用户的额外视频流
unRequestExtraStreamVideo (opens new window) 取消订通话中其他用户的额外视频流
enableLocalRecord (opens new window) 开启/关闭本地录制
updateLocalRecordLayout (opens new window) 更新本地录制自定义布局
isLocalRecording (opens new window) 是否正在本地录制
enableRemoteRecord (opens new window) 开启/关闭远程视频录制
updateRemoteRecordLayout (opens new window) 更新远程录制自定义布局
updateRemoteRecordWatermark (opens new window) 更新远程录制水印信息
getRemoteRecordState (opens new window) 获取远程视频录制状态
setVideoDot (opens new window) 远程录制视频打点
enableMicAgc (opens new window) 开启或关闭本地麦克风的增益(软件增益)
setSubScreenShare (opens new window) 设置是否订阅屏幕共享
isSubScreenShare (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) 座席处理加急的结果回调

# 座席管理

方法 描述
create (opens new window) 创建 JRTCAgent (opens new window) 对象
destroy (opens new window) 销毁 JRTCAgent (opens new window) 对象
isAutoRecord (opens new window) 检查当前通话是否为服务器自动录制模式
getCallState (opens new window) 获取当前通话状态
getCallType (opens new window) 获取当前通话类型
getHoldState (opens new window) 获取当前通话保持状态
setHoldState (opens new window) 设置通话保持/取回状态
isOnewayVideo (opens new window) 获取单向视频状态
getTermState (opens new window) 获取结束通话后的座席状态
setTermState (opens new window) 设置通话结束后的座席状态
getOperatorState (opens new window) 获取座席签入状态
isPause (opens new window) 获取座席示忙/示闲状态
isMainAgent (opens new window) 判断当前座席是否为主座席
getMainGuestParticipant (opens new window) 获取主访客成员信息
getGuestParticipants (opens new window) 获取所有访客成员列表
getSelfParticipant (opens new window) 获取当前座席自己的成员信息
getParticipants (opens new window) 获取通话中的所有成员列表
getSerialNumber (opens new window) 获取业务唯一标识
getCallId (opens new window) 获取通话唯一标识
getStatistics (opens new window) 获取统计信息
getJsonStats (opens new window) 获取实时统计信息
getSupportVideoSizes (opens new window) 获取当前通话支持的视频分辨率列表
setUseExternalScreenCaptureControl (opens new window) 设置屏幕采集控制模式
queryAllGroups (opens new window) 查询所有业务号列表
queryAvailableAgentList (opens new window) 查询指定业务号的空闲座席列表
checkin (opens new window) 座席签入
checkout (opens new window) 座席签出
joinCall (opens new window) 加入通话
recall (opens new window) 座席回呼
answer (opens new window) 接听来电
term (opens new window) 结束通话
applyStatePause (opens new window) 设置示忙/示闲状态
transferCall (opens new window) 通话转接
turnCallType (opens new window) 音视频通话类型切换
turnCallTypeForSip (opens new window) 请求SIP成员切换音视频通话类型
inviteThirdGuest (opens new window) 邀请第三方访客加入通话
inviteThirdAgent (opens new window) 邀请第三方座席加入通话
switchPartRole (opens new window) 切换自己在通话中角色
kickParticipant (opens new window) 踢出通话成员
requestSign (opens new window) 请求访客签名
requestOnewayVideo (opens new window) 请求单向视频
responseUrgent (opens new window) 处理访客加急请求
sendMessage (opens new window) 发送消息
sendNotifyMessage (opens new window) 发送事件通知消息
enableUploadAudioStream (opens new window) 开启/关闭发送本地音频流
enableUploadVideoStream (opens new window) 开启/关闭发送本地视频流
getUploadLocalAudio (opens new window) 获取本地音频数据是否在上传
getUploadLocalVideo (opens new window) 获取本地视频数据是否在上传
sendVideoEmptyPack (opens new window) 发送视频空包
sendAudioEmptyPack (opens new window) 发送音频空包
enableScreenShare (opens new window) 开启/关闭屏幕共享
suspendScreenShare (opens new window) 暂停/继续屏幕共享
isSuspendScreenShare (opens new window) 获取屏幕共享是否处于暂停状态
getShareStreamId (opens new window) 获取屏幕共享的视频流ID
getShareUserId (opens new window) 获取发起屏幕共享者的用户ID
setRatio (opens new window) 设置本端视频宽高比
getRequestSize (opens new window) 获取视频请求尺寸
setRequestSize (opens new window) 设置视频请求尺寸
requestVideo (opens new window) 订阅通话中其他成员的视频流
unRequestVideo (opens new window) 取消订阅通话中其他成员的视频流
requestScreenVideo (opens new window) 订阅通话中屏幕共享的视频流
unRequestScreenVideo (opens new window) 取消订阅通话中屏幕共享的视频流
controlRecord (opens new window) 开启/关闭远程录制
enableLocalRecord (opens new window) 开启/关闭本地录制
updateLocalRecordLayout (opens new window) 更新本地录制自定义布局
isLocalRecording (opens new window) 是否正在本地录制
enableRemoteRecord (opens new window) 开启/关闭远程视频录制
updateRemoteRecordLayout (opens new window) 更新远程录制自定义布局
updateRemoteRecordWatermark (opens new window) 更新远程录制水印信息
getRemoteRecordState (opens new window) 获取远程视频录制状态
setVideoDot (opens new window) 远程录制视频打点
enableMicAgc (opens new window) 开启或关闭本地麦克风的增益(软件增益)
setSubScreenShare (opens new window) 设置是否订阅屏幕共享
isSubScreenShare (opens new window) 获取是否订阅屏幕共享

# 座席事件

事件 描述
onGetAllGroups (opens new window) 获取业务号列表结果回调
onCheckin (opens new window) 签入回调
onCheckout (opens new window) 签出回调
onCheckStateChanged (opens new window) 签入/签出状态改变回调
onCallStateChanged (opens new window) 通话状态改变回调
onCheckin (opens new window) 签入回调
onCallQueueCount (opens new window) 当前排队人数上报回调
onApplyResult (opens new window) 示忙/示闲回调
onTransferCallResult (opens new window) 通话转接结果回调
onMemberJoin (opens new window) 通话中有新成员加入回调
onMemberLeave (opens new window) 通话中有成员离开回调
onMemberUpdate (opens new window) 通话中成员属性更新回调
onCallPropertyChanged (opens new window) 通话属性改变回调
onUrgentRequest (opens new window) 收到加急请求回调
onResponseUrgentResult (opens new window) 处理加急请求结果回调
onQueryAvailableAgentList (opens new window) 查询空闲座席结果回调
onHoldStateChanged (opens new window) 收到通话保持或取回的回调
onCallTypeChanged (opens new window) 音视频通话模式切换回调
onTurnCallTypeForSipResult (opens new window) 请求SIP成员切换音视频模式结果回调
onMessageReceived (opens new window) 收到消息回调
onDeliveryAbort (opens new window) 录制异常回调
onInviteThirdAgentResult (opens new window) 邀请第三方座席结果回调
onInviteThirdGuestResult (opens new window) 邀请第三方访客结果回调
onNotifyMessageReceived (opens new window) 收到事件通知消息回调
onOnewayVideoChanged (opens new window) 单向视频状态变化回调
onSignResultResponse (opens new window) 访客签名请求结果回调
onSwitchPartRoleResult (opens new window) 切换自己在通话中角色结果回调
onKickParticipantResult (opens new window) 踢出通话成员结果回调