<NIMSignalManager>协议 参考

#import <NIMSignalManagerProtocol.h>

类 <NIMSignalManager> 继承关系图:

构造函数
(void)	- signalingCreateChannel:completion:
(void)	- signalingCloseChannel:completion:
(void)	- signalingJoinChannel:completion:
(void)	- signalingLeaveChannel:completion:
(void)	- signalingInvite:completion:
(void)	- signalingCancelInvite:completion:
(void)	- signalingReject:completion:
(void)	- signalingAccept:completion:
(void)	- signalingJoinAndAccept:completion:
(void)	- signalingControl:completion:
(void)	- signalingCall:completion:
(void)	- signalingCallEx:completion:
(void)	- signalingQueryChannelInfo:completion:
(void)	- addDelegate:
(void)	- removeDelegate:

详细描述

通用音视频信令协议

函数文档

addDelegate:

- (void) addDelegate:

(id< NIMSignalManagerDelegate >)

delegate

添加通知对象

参数

delegate

通知对象

removeDelegate:

- (void) removeDelegate:

(id< NIMSignalManagerDelegate >)

delegate

移除通知对象

参数

delegate

通知对象

signalingAccept:completion:

- (void) signalingAccept:		(NIMSignalingAcceptRequest *)	request
completion:		(nullable NIMSignalingAcceptBlock)	completion

接受邀请

参数

request	接受邀请请求
completion	完成回调 @discussion 接受频道接口 不开自动加入开关：该接口只接受邀请并告知邀请者，并同步通知自己的其他在线设备，但不会主动加入频道，需要单独调用加入接口 打开自动加入开关：该接口为组合接口，等同于先调用接受邀请，成功后再加入房间。 @discussion 错误码 200:成功 10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受 10407:已经房间内 10420:已经在房间内（自己的其他端） 10419:房间人数超限 10417:uid冲突

signalingCall:completion:

- (void) signalingCall:		(NIMSignalingCallRequest *)	request
completion:		(nullable NIMSignalingCallBlock)	completion

呼叫

参数

request	呼叫请求
completion	完成回调 @discussion 用于用户新开一个频道并邀请对方加入频道，该接口为组合接口，等同于用户先创建频道，成功后加入频道并邀请对方 @discussion 错误码 200:成功 10405:房间已存在 10201:对方云信不在线 10202:对方推送不可达。该接口是用户呼叫场景的组合接口封装，调用该接口，sdk底层分别会 创建、加入、邀请，再返回用户结果，其中任何一步失败，就返回失败（其中邀请返回10201和10202，认为是成功，返回码还是10201和10202给上层），失败时，sdk需要主动close。常用于但不限于点对点呼叫发起。 @discussion error的错误码为10201和10202时，返回的房间信息时有效的，需要用户主动close房间

signalingCallEx:completion:

- (void) signalingCallEx:		(NIMSignalingCallExRequest *)	request
completion:		(nullable NIMSignalingOptimizationCallBlock)	completion

呼叫 （优化）

参数

request	呼叫请求
completion	完成回调 @discussion 用于用户新开一个频道并邀请对方加入频道，该接口为组合接口 ，对老接口进行优化。等同于用户先创建频道，成功后加入频道并邀请对方 @discussion 错误码 200:成功 10405:房间已存在 10201:对方云信不在线 10202:对方推送不可达。该接口是用户呼叫场景的组合接口封装，调用该接口，sdk底层分别会 创建、加入、邀请，再返回用户结果，其中任何一步失败，就返回失败（其中邀请返回10201和10202，认为是成功，返回码还是10201和10202给上层），失败时，sdk需要主动close。常用于但不限于点对点呼叫发起。 @discussion error的错误码为10201和10202时，返回的房间信息时有效的，需要用户主动close房间

signalingCancelInvite:completion:

- (void) signalingCancelInvite:		(NIMSignalingCancelInviteRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

取消邀请

参数

request	取消邀请请求
completion	完成回调 @discussion 错误码 200:成功 10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受

signalingCloseChannel:completion:

- (void) signalingCloseChannel:		(NIMSignalingCloseChannelRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

关闭频道

参数

request	关闭频道请求
completion	完成回调 @discussion 该接口可以由创建者和频道内所有成员调用，无权限限制。调用该接口成功后，其他所有频道内的成员都回收到频道结束的通知，被动离开频道。此时其他成员需要调用离开接口，也不会收到别人的离开通知。 @discussion 错误码 200:成功 10406:不在房间内

signalingControl:completion:

- (void) signalingControl:		(NIMSignalingControlRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

自定义控制指令

参数

request	自定义控制指令请求
completion	完成回调 @discussion 该接口用于在频道中透传一些自定义指令，协助频道管理。该接口允许非频道内成员调用，但接收者必须是频道内成员或创建者 @discussion 错误码 200:成功 10404:房间不存在 10406:不在房间内（自己或者对方）

signalingCreateChannel:completion:

- (void) signalingCreateChannel:		(NIMSignalingCreateChannelRequest *)	request
completion:		(nullable NIMSignalingCreateChannelBlock)	completion

创建频道

参数

request	创建频道请求
completion	完成回调 @discussion 该接口用户创建频道，同一时刻频道名互斥，不能重复创建。但如果频道名缺省，服务器会自动分配频道id。对于频道在创建后如果没人加入，有效期2小时，当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。 @discussion 错误码 200:成功 10405:房间已存在

signalingInvite:completion:

- (void) signalingInvite:		(NIMSignalingInviteRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

邀请加入频道

参数

request	邀请加入频道请求
completion	完成回调 @discussion 该接口用于邀请对方加入频道，邀请者必须是创建者或者是频道中成员。如果需要对离线成员邀请，可以打开离线邀请开关并填写推送信息。被邀请者在线后通过离线通知接收到该邀请，并通过房间信息中的invalid_字段判断房间的有效性，也可以对所有离线消息处理后判断该邀请是否被取消。 @discussion 错误码 200:成功 10404:房间不存在 10406:不在房间内（自己）10407:已经房间内（对方）10419:房间人数超限 10201:对方云信不在线 10202:对方推送不可达

signalingJoinAndAccept:completion:

- (void) signalingJoinAndAccept:		(NIMSignalingJoinAndAcceptRequest *)	request
completion:		(nullable NIMSignalingOptimizationCallBlock)	completion

接受邀请并加入

参数

request	接受邀请请求
completion	完成回调 @discussion 接受频道邀请并加入接口 该接口接受邀请并告知邀请者，并同步通知自己的其他在线设备，并主动加入频道。 @discussion 错误码 200:成功 10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受 10407:已经房间内 10420:已经在房间内（自己的其他端） 10419:房间人数超限 10417:uid冲突

signalingJoinChannel:completion:

- (void) signalingJoinChannel:		(NIMSignalingJoinChannelRequest *)	request
completion:		(nullable NIMSignalingJoinChannelBlock)	completion

加入频道

参数

request	加入频道请求
completion	完成回调 @discussion 错误码 200:成功 10407:已经房间内 10420:已经在房间内（自己的其他端） 10419:房间人数超限 10417:uid冲突

signalingLeaveChannel:completion:

- (void) signalingLeaveChannel:		(NIMSignalingLeaveChannelRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

离开频道

参数

request	离开频道请求
completion	完成回调 @discussion 该接口用于自己退出频道，但不对频道进行销毁 @discussion 错误码 200:成功 10406:不在房间内

signalingQueryChannelInfo:completion:

- (void) signalingQueryChannelInfo:		(NIMSignalingQueryChannelRequest *)	request
completion:		(nullable NIMSignalingQueryChannelBlock)	completion

查询频道信息

参数

request	查询请求
completion	完成回调

signalingReject:completion:

- (void) signalingReject:		(NIMSignalingRejectRequest *)	request
completion:		(nullable NIMSignalingOperationBlock)	completion

拒绝邀请

参数

request	拒绝邀请请求
completion	完成回调 @discussion 拒绝邀请后用户也可以通过加入频道接口加入频道，接口的使用由用户的业务决定 @discussion 错误码 200:成功 10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受

---

该协议的文档由以下文件生成:

• NIMSignalManagerProtocol.h