视频通话插件 - iOS v2601.0
载入中...
搜索中...
未找到
JCCCommonManager类 参考

通用插件接口管理基类 更多...

#include <JCCCommonManager.h>

实例方法

(BOOL) - login:
 初始化并登录,登录结果通过 onLogin 回调通知
(BOOL) - logout
 登出并销毁,登出结果通过 onLogout 回调通知
(JCCClientState- getClientLoginState
 获取当前登录状态
(int) - sendOnlineMessage:userId:
 发送在线消息
(bool) - sendMessageInCall:content:toUserId:
 透明通道发送消息给某个成员,userId 传空则发送给所有成员,消息内容不能大于4K
(void) - uploadFile:
 上传文件
(NSString *) - getCallId
 获取通话ID
(void) - setCustomConfig:
 设置定制配置参数
(void) - setVideoAngle:
 设置视频旋转角度
(void) - miniTalkingWindow
(void) - restoreTalkingWindow
(void) - switchFocusVideoView
(BOOL) - enableRemoteCollaboration:
(JCCVersion *) - getVersion
 获取SDK和底层库的版本号信息
(void) - addCallback:
 订阅回调
(void) - removeCallback:
 取消订阅回调
实例方法 继承自 <JCCCommonCallback>
(void) - onLogin:reason:
 登录结果回调
(void) - onLogout:
 登出回调
(void) - onOnlineMessageSendResult:operatorId:
 在线消息发送结果
(void) - onOnlineMessageReceived:userId:
 收到在线消息
(void) - onUploadFileResult:response:
 文件上传成功
(void) - onUploadFileError:error:
 文件上传失败
(void) - onMessageInCallReceived:content:fromUserId:
 接收通话中消息的回调
(void) - onMessageSendResult:result:error:
(void) - onError:errorCodeDetail:
(void) - onSystemPhoneStateChanged:oldState:
(BOOL) - onViewEvent:

属性

engine
 获取 SDK 引擎对象,登录后可用于调用底层 SDK 接口,非特殊场景不建议直接使用

详细描述

通用插件接口管理基类

成员函数文档

◆ addCallback:

- (void) addCallback: (F) callback

订阅回调

参数
callback回调代理对象

◆ enableRemoteCollaboration:

- (BOOL) enableRemoteCollaboration: (BOOL) enable

开启/关闭远程协作

参数
enable
  • true 开启
  • false 关闭
返回
接口调用结果
  • true:接口调用成功
  • false:接口调用失败

◆ getCallId

- (NSString *) getCallId

获取通话ID

返回
当前通话ID

◆ getClientLoginState

- (JCCClientState) getClientLoginState

获取当前登录状态

返回
当前登录状态

◆ getVersion

- (JCCVersion *) getVersion

获取SDK和底层库的版本号信息

返回
SDK版本信息

◆ login:

- (BOOL) login: (JCCLoginParam *) param

初始化并登录,登录结果通过 onLogin 回调通知

参数
param初始化和登录的基本配置信息
返回
接口调用结果
  • YES 表示调用成功
  • NO 表示调用异常

◆ logout

- (BOOL) logout

登出并销毁,登出结果通过 onLogout 回调通知

返回
接口调用结果
  • YES 表示调用成功
  • NO 表示调用异常

◆ miniTalkingWindow

- (void) miniTalkingWindow

最小化通话窗口

◆ removeCallback:

- (void) removeCallback: (F) callback

取消订阅回调

参数
callback回调代理对象

◆ restoreTalkingWindow

- (void) restoreTalkingWindow

恢复通话窗口

◆ sendMessageInCall:content:toUserId:

- (bool) sendMessageInCall: (NSString *) type
content: (NSString *) content
toUserId: (nullable NSString *) userId 

透明通道发送消息给某个成员,userId 传空则发送给所有成员,消息内容不能大于4K

参数
type消息类型
content消息内容
userId对象ID
返回
接口调用结果
  • YES 表示调用成功
  • NO 表示调用异常

◆ sendOnlineMessage:userId:

- (int) sendOnlineMessage: (NSString *_Nonnull) message
userId: (NSString *_Nonnull) userId 

发送在线消息

参数
message消息内容
userId对方用户ID
返回
接口调用结果

◆ setCustomConfig:

- (void) setCustomConfig: (T) customConfig

设置定制配置参数

参数
customConfig定制化配置参数

◆ setVideoAngle:

- (void) setVideoAngle: (JCCMediaDeviceVideoAngle) angle

设置视频旋转角度

参数
angle视频旋转角度,参看 JCCMediaDeviceVideoAngle

◆ switchFocusVideoView

- (void) switchFocusVideoView

切换焦点视频

注解
画中画模式(一对一通话场景),大小屏切换 演讲者模式(多人通话场景),循环切换大屏成员 宫格模式,不支持

◆ uploadFile:

- (void) uploadFile: (JCCUploadFileParam *) param

上传文件

参数
param文件上传信息,参看 JCCUploadFileParam