JCallManager类 参考

多方通话 2.0 接口管理类 更多...

#include <JCallManager.h>

实例方法
(void)	- setRole:
(bool)	- join:joinParam:
(bool)	- leave
(bool)	- stop
(int)	- invite:inviteParam:
(int)	- cancelInvite
(int)	- acceptInvite:
(int)	- acceptInvite:acceptParam:
(int)	- rejectInvite
(void)	- addCallback:
	订阅回调
(void)	- removeCallback:
	取消订阅回调
实例方法 继承自 JCCCommonManager
(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:
实例方法 继承自 <JCallCallback>
(void)	- onJoin:reasonCode:
(void)	- onLeave:reasonCode:
(void)	- onInviteResult:result:reason:
(void)	- onCancelInviteResult:result:reason:
(void)	- onAcceptInviteResult:result:reason:
(void)	- onRejectInviteResult:result:reason:
(void)	- onInviteReceived:
(void)	- onInviteCanceled:
(void)	- onInviteAccepted:
(void)	- onInviteRejected:

类方法
(JCallManager *)	+ shared
	获取管理类单例

额外继承的成员函数
属性 继承自 JCCCommonManager
E	engine
	获取 SDK 引擎对象，登录后可用于调用底层 SDK 接口，非特殊场景不建议直接使用

详细描述

多方通话 2.0 接口管理类

成员函数文档

acceptInvite:

- (int) acceptInvite:

(bool)

video

接受邀请

参数

video

是否需要视频

返回

• 操作id: 接口调用成功，对应 onAcceptInviteResult:result:reason: 回调的 operatorId 参数
• -1: 接口调用异常，不会收到回调

acceptInvite:acceptParam:

- (int) acceptInvite:		(bool)	video
acceptParam:		(JCallAcceptParam *__nullable)	acceptParam

接受邀请

参数

video	是否需要视频
acceptParam	接受邀请参数

返回

• 操作id: 接口调用成功，对应 onAcceptInviteResult:result:reason: 回调的 operatorId 参数
• -1: 接口调用异常，不会收到回调

addCallback:

- (void) addCallback:

(id< JCallCallback >)

callback

订阅回调

参数

callback

回调代理对象

cancelInvite

- (int) cancelInvite

取消邀请

返回

• 操作id: 接口调用成功，对应 onCancelInviteResult:result:reason: 回调的 operatorId 参数
• -1: 接口调用异常，不会收到回调

invite:inviteParam:

- (int) invite:		(NSString *)	calleeUserId
inviteParam:		(JCallExtraParam *)	inviteParam

邀请其他成员加入通话

注解

需要已经加入通话

参数

calleeUserId	被邀请者用户ID
inviteParam	邀请参数

返回

• 操作id: 接口调用成功，对应 onInviteResult:result:reason: 回调的 operatorId 参数
• -1: 接口调用异常，不会收到回调

join:joinParam:

- (bool) join:		(NSString *__nullable)	serialId
joinParam:		(JCallJoinParam *__nullable)	joinParam

加入通话

注解

需要已经登录

该接口支持加入通话并邀请其他用户加入，可通过 inviteCalleeUserId 和 inviteCalleeUserType 设置需要邀请的用户 ID 和用户类型

该方法让用户加入通话，在同一个通话内的用户可以互相视频语音。
如果用户已在通话中，必须退出当前通话，即处于空闲状态，才能进入其他通话，否则将直接返回 false，且不会收到回调通知。

参数

serialId	业务流水号，保证唯一，可选，如果传空，则服务器默认生成
joinParam	加入通话参数，传 null 则使用默认参数

参见

JRTCCallJoinParam

返回

接口调用结果

• true: 接口调用成功，会收到 onJoin 回调
• false: 接口调用异常

leave

- (bool) leave

离开通话

注解

仅自己离开

需要已经加入通话

返回

接口调用结果

• true: 接口调用成功，非空闲状态下，会收到 onLeave 回调
• false: 接口调用异常

rejectInvite

- (int) rejectInvite

拒绝邀请

返回

• 操作id: 接口调用成功，对应 onRejectInviteResult:result:reason: 回调的 operatorId 参数
• -1: 接口调用异常，不会收到回调

removeCallback:

- (void) removeCallback:

(id< JCallCallback >)

callback

取消订阅回调

参数

callback

回调代理对象

setRole:

- (void) setRole:

(JCCPartRole)

role

设置用户角色

注解

该接口只有在接受邀请前设置有效，主动加入通话，请使用加入通话参数设置

参数

role

用户角色

stop

- (bool) stop

结束通话

注解

自己离开并踢出通话中的其他成员

需要已经加入通话

返回

接口调用结果

• true: 接口调用成功，非空闲状态下，会收到 onLeave 回调
• false: 接口调用异常