NIMRTSManager Protocol Reference

Conforms to NSObject
Declared in NIMRTSManagerProtocol.h

Overview

实时会话协议

– requestRTS:services:option:completion: required method

主叫发起实时会话请求

- (NSString *)requestRTS:(NSArray<NSString*> *)callees services:(NSUInteger)types option:(nullable NIMRTSOption *)option completion:(nullable NIMRTSRequestHandler)completion

Parameters

callees

被叫帐号列表, 当前版本只支持一个被叫
types

实时会话服务类型, NIMRTSService的组合, 如果要同时发起可靠传输通道和音频通话, 使用 NIMRTSServiceReliableTransfer | NIMRTSServiceAudio
option

发起会话附带的选项, 可以是nil
completion

发起实时会话结果回调

Return Value

发起的实时会话ID

Discussion

主叫发起实时会话请求

Declared In

NIMRTSManagerProtocol.h

– responseRTS:accept:option:completion: required method

被叫响应实时会话请求

- (void)responseRTS:(NSString *)sessionID accept:(BOOL)accept option:(nullable NIMRTSOption *)option completion:(nullable NIMRTSResponseHandler)completion

Parameters

sessionID

实时会话ID
accept

是否接听
option

接收会话附带的选项, 可以是nil
completion

响应呼叫结果回调

Discussion

被叫响应实时会话请求

Declared In

NIMRTSManagerProtocol.h

– terminateRTS: required method

挂断实时会话

- (void)terminateRTS:(NSString *)sessionID

Parameters

sessionID

需要挂断的实时会话ID

Discussion

挂断实时会话

被叫在响应请求之前不要调用挂断接口

Declared In

NIMRTSManagerProtocol.h

– sendRTSData:from:to:with: required method

从指定通道发送数据

- (BOOL)sendRTSData:(NSData *)data from:(NSString *)sessionID to:(nullable NSString *)userID with:(NIMRTSService)service

Parameters

data

需要发送的实时会话数据, 数据长度不允许超过50KB, 推荐不超过4KB; 发送数据的周期建议控制在50ms以上
sessionID

实时会话ID
userID

发送数据目标用户名, nil表示广播给所有用户
service

实时会话服务类型

Return Value

是否允许发送

Discussion

从指定通道发送数据

被叫在响应请求之前不要调用挂断接口

Declared In

NIMRTSManagerProtocol.h

– sendRTSControl:forSession: required method

发送实时会话控制指令

- (void)sendRTSControl:(NSString *)controlInfo forSession:(NSString *)sessionID

Parameters

controlInfo

控制信息, 自定义实现
sessionID

实时会话ID

Discussion

发送实时会话控制指令

Declared In

NIMRTSManagerProtocol.h

– setMute: required method

设置当前实时会话静音模式

- (void)setMute:(BOOL)mute

Parameters

mute

是否开启静音

Discussion

设置当前实时会话静音模式

Declared In

NIMRTSManagerProtocol.h

– setSpeaker: required method

设置当前实时会话扬声器模式

- (void)setSpeaker:(BOOL)useSpeaker

Parameters

useSpeaker

是否开启扬声器

Discussion

设置当前实时会话扬声器模式

Declared In

NIMRTSManagerProtocol.h

– addDelegate: required method

添加实时会话委托

- (void)addDelegate:(id<NIMRTSManagerDelegate>)delegate

Parameters

delegate

实时会话委托

Discussion

添加实时会话委托

Declared In

NIMRTSManagerProtocol.h

– removeDelegate: required method

移除实时会话委托

- (void)removeDelegate:(id<NIMRTSManagerDelegate>)delegate

Parameters

delegate

实时会话委托

Discussion

移除实时会话委托

Declared In

NIMRTSManagerProtocol.h

– setUpRTSSocksWithParam: required method

配置白板代理参数

- (void)setUpRTSSocksWithParam:(NIMRTSSocksParam *)socksParam

Parameters

socksParam

代理参数

Discussion

配置白板代理参数

Declared In

NIMRTSManagerProtocol.h

– setUpGlobalSocksWithParam: required method

配置全局代理，包括白板代理和音视频代理

- (void)setUpGlobalSocksWithParam:(NIMRTSSocksParam *)socksParam

Parameters

socksParam

代理参数

Discussion

配置全局代理，包括白板代理和音视频代理

Declared In

NIMRTSManagerProtocol.h