iOS

# 概览

# 登录登出管理

方法 描述
create 创建 JRTCClient (opens new window) 对象
destroy 销毁 JRTCClient (opens new window) 对象
setForeground 设置是否为前台
getUserId 获取用户ID
getState 获取当前登录状态
getDisplayName 获取用户昵称
setDisplayName 设置用户昵称
getServer 获取接入服务器地址
setServer 设置接入服务器地址
getAppKey 获取 AppKey
setAppKey 设置 AppKey
getAppName 获取应用名称
setAppName 设置应用名称
login 登录 Juphoon RTC 平台
reLogin 重登录 Juphoon RTC 平台
logout 登出 Juphoon RTC 平台
sendOnlineMessage 发送在线消息
getUploadUrl 获取文件上传路径
createP2PSession 创建 P2P 会话
requestFileUploadInfo 获取文件上传或断点续传信息
completeFileUpload 文件上传完成确认
getUploadFileInfo 获取上传文件信息列表

# 登录登出事件

事件 描述
onLogin 登录结果回调
onLogout 登出回调
onClientStateChange 登录状态变化通知
onOnlineMessageSendResult 在线消息发送结果回调
onOnlineMessageReceived 收到在线消息回调
onGetUploadUrlResponse 获取文件上传地址等信息回调
onSDKEvent 上报事件回调
onP2PSessionCreate P2P 会话创建结果
onP2PSessionConnect P2P 会话连接
onP2PSessionClose P2P 会话关闭
onP2PMessageReceived 收到 P2P 会话消息
onRequestFileUploadInfoResponse 获取文件上传或断点续传信息响应
onCompleteFileUploadResponse 文件上传完成确认响应
onGetUploadFileInfoResponse 获取上传文件信息列表响应
onFileUploadPlatformNotify 文件上传到影像平台结果通知

# 设备管理

方法 描述
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) 获取摄像头列表
startCameraVideo (opens new window) 开始本端视频渲染
startVideo (opens new window) 开始远端视频渲染
stopVideo (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) 设置屏幕共享采集属性
getCameraType (opens new window) 获取摄像头类型
enableSpeaker (opens new window) 开启/关闭扬声器
changeAudioOutput (opens new window) 切换音频输出通道
getBluetoothName (opens new window) 获取连接的蓝牙名称
isVideoFileOpen (opens new window) 是否开启文件视频源
getVideoFileId (opens new window) 获取文件视频源ID
startVideoFile (opens new window) 开启视频文件作为视频输入源
setVideoFileFrame (opens new window) 逐帧采集视频画面
stopVideoFile (opens new window) 关闭视频文件作为视频输入源
getAudioRouteType (opens new window) 获得当前音频输出通道类型
setVideoAngle (opens new window) 设置视频窗体角度
getVideoAngle (opens new window) 获取视频窗体角度
startVideoCaptureRecord (opens new window) 开启视频录制
stopVideoCaptureRecord (opens new window) 关闭视频录制
startAudioRecord (opens new window) 开启音频录制
stopAudioRecord (opens new window) 关闭音频录制
getScreenCaptureId (opens new window) 获取屏幕共享采集ID
enableScreenCapture (opens new window) 开启/关闭屏幕采集
stopAllVideos (opens new window) 停止所有视频渲染
snapshotWithStreamID (opens new window) 截图
setAudioInputFrameCallback (opens new window) 设置音频输入帧回调
setVideoCaptureFrameCallback (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) 结束播放音频
setAec (opens new window) 设置开启自适应回声消除
setAgc (opens new window) 设置是否开启自动增益控制

# 设备事件

事件 描述
onAudioError (opens new window) 音频异常回调
onAudioRouteTypeChanged (opens new window) 音频输出通道变化回调
onCameraUpdate (opens new window) 摄像头变化回调
onVideoCaptureDidStart (opens new window) 视频采集开始回调
onRenderStart (opens new window) 渲染开始回调
onRenderReceived (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) 音频播放完成

# 多方通话管理

方法 描述
create (opens new window) 创建 JRTCRoom (opens new window) 对象
destroy (opens new window) 销毁 JRTCRoom (opens new window) 对象
getRoomId (opens new window) 获取房间号
getPassword (opens new window) 获取房间密码
getCallId (opens new window) 获取房间唯一标识(服务器生成)
getTitle (opens new window) 获取房间标题
getState (opens new window) 获取自己当前在房间中的状态
getParticipants (opens new window) 获取房间中的所有成员
getUploadLocalAudio (opens new window) 获取本地音频数据是否在上传
getUploadLocalVideo (opens new window) 获取本地视频数据是否在上传
getAudioOutput (opens new window) 获取音频是否输出
getShareStreamId (opens new window) 获取屏幕共享时的视频流ID,无屏幕共享时为 null
getShareUserId (opens new window) 获取发起屏幕共享者的用户ID,无屏幕共享时为 null
isLocalRecording (opens new window) 获取是否正在本地录制
getRemoteRecordState (opens new window) 获取远程视频录制状态
getCDNState (opens new window) 获取CDN推流状态
setNotifyVolumeChange (opens new window) 设置是否上报音量变化,音量变化会比较频繁,默认为 true,不需要则设置为 false
isNotifyVolumeChange (opens new window) 获取是否上报音量变化
getSupportVideoSizes (opens new window) 获取房间支持的视频分辨率列表
setUseExternalScreenCaptureControl (opens new window)} 设置是否由应用层自行控制屏幕采集逻辑,默认 false
query (opens new window) 查询房间相关信息
join (opens new window) 加入房间
leave (opens new window) 离开房间
enableUploadAudioStream (opens new window) 开启/关闭发送本地音频流
enableUploadVideoStream (opens new window) 开启/关闭发送本地视频流
enableAudioOutput (opens new window) 开启/关闭音频输出
requestVideo (opens new window) 订阅通话中其他用户的视频流
unRequestVideo (opens new window) 取消订阅房间中其他用户的视频流
requestScreenVideo (opens new window) 订阅通话中屏幕共享的视频流
unRequestScreenVideo (opens new window) 取消订阅通话中屏幕共享的视频流
enableLocalRecord (opens new window) 开启/关闭本地录制
updateLocalRecordLayout (opens new window) 更新本地录制自定义布局
enableCdn (opens new window) 开启/关闭Cdn推流
enableRemoteRecord (opens new window) 开启/关闭远程录制
enableScreenShare (opens new window) 开启/关闭屏幕共享
suspendScreenShare (opens new window) 暂停/继续屏幕共享
isSuspendScreenShare (opens new window) 是否屏幕共享暂停
enableAudioInputFromFile (opens new window) 开始/结束本地文件音频源输入
suspendAudioInputFromFile (opens new window) 暂停/继续本地文件音频源输入
getParticipant (opens new window) 根据用户标识获取房间成员
getStatistics (opens new window) 获取统计信息
getJsonStats (opens new window) 获取天赛实时统计信息
setCustomProperty (opens new window) 设置房间自定义属性
getCustomProperty (opens new window) 获取房间自定义属性
sendMessage (opens new window) 发送房间消息,消息内容不能大于4K
inviteSipUser (opens new window) 邀请Sip用户,一般用于对接落地网关等
setRatio (opens new window) 设置本端视频宽高比
sendAudioEmptyPack (opens new window) 发送音频空包
sendVideoEmptyPack (opens new window) 发送视频空包
setVideoDot (opens new window) 视频打点
enableMicAgc (opens new window) 开启或关闭本地麦克风的增益(软件增益),默认开启

# 多方通话事件

事件 描述
onRoomStateChanged (opens new window) 自身在房间中的状态变化回调
onRoomPropertyChanged (opens new window) 房间属性变化回调
onJoin (opens new window) 加入房间结果回调
onLeave (opens new window) 离开房间结果回调
onQuery (opens new window) 查询房间信息结果回调
onParticipantJoin (opens new window) 成员加入回调
onParticipantLeft (opens new window) 成员离开回调
onParticipantUpdate (opens new window) 成员更新回调
onMessageReceived (opens new window) 接收房间消息的回调
onInviteSipUserResult (opens new window) 邀请Sip用户结果回调
onDeliveryAbort (opens new window) 录制异常回调
onFileAudioInputFinish (opens new window) 本地文件音频源输入完成回调
onEnableRemoteAdvancedRecordResult (opens new window) 开启远程录制(增强录制)结果回调