@interface RTS : NSObject
objectivec

SDK 回调给应用层的 delegate 对象

+ (void)destroyRTS;
objectivec

销毁引擎实例对象。

注意

• 请确保和需要销毁的 RTS 实例相关的业务场景全部结束后，才调用此方法。
• 该方法在调用之后，会销毁所有和此 RTS 实例相关的内存，并且停止与媒体服务器的任何交互。
• 调用本方法会启动 SDK 退出逻辑。引擎线程会保留，直到退出逻辑完成。因此，不要在回调线程中直接调用此 API，也不要在回调中等待主线程的执行，并同时在主线程调用本方法。不然会造成死锁。
• 可以通过 Objective-C 的ARC机制，在 dealloc 时自动触发销毁逻辑。

+ (NSString * _Nonnull)getSdkVersion;
objectivec

获取 SDK 当前的版本号。

返回值
SDK 当前的版本号。

+ (RTS * _Nullable)createRTS:(NSString * _Nonnull)appId delegate:(id<RTSDelegate> _Nullable)delegate parameters:(NSDictionary* _Nullable)parameters;
objectivec

创建引擎对象

如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTS 提供的各种消息能力。

如果当前进程中已创建了引擎实例，再次调用此方法时，会创建另一个独立的引擎实例。

传入参数

返回值
可用的 RTSDelegate 实例。

- (int)setBusinessId:(NSString* _Nullable)businessId;
objectivec

设置业务标识参数

可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。

传入参数

返回值

• 0： 成功
• < 0： 失败
• -6001： 用户已经在房间中。
• -6002： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符分别是：英文句号，短横线，下划线和 @ 。

注意
需要在调用 joinRoom 之前调用，joinRoom之后调用该方法无效。

- (void)setRuntimeParameters:(NSDictionary * _Nullable)parameters;
objectivec

设置运行时的参数

传入参数

- (RTSRoom * _Nullable)createRoom:(NSString * _Nonnull)roomId;
objectivec

创建并获取一个 RTSRoom 对象

用户可以多次调用此方法创建多个 RTSRoom 实例，再分别调用各 RTSRoom 对象的 joinRoom 方法，实现同时加入多个房间。

传入参数

返回值
创建的 RTSRoom 实例

- (int64_t)login:(NSString * _Nonnull)token uid:(NSString * _Nonnull)uid;
objectivec

登录 RTS 服务器。

必须先登录，才能收发消息。

在调用本接口登录后，如果想要登出，需要调用 logout

传入参数

返回值

• 0：成功
• -1：失败。无效参数
• -2：无效调用。用户已经登录。成功登录后再次调用本接口将收到此返回值
• -3：失败。Engine 为空。

注意
本地用户调用此方法登录后，会收到 rtcEngine:onLoginResult:errorCode:elapsed:rtsEngine:onLoginResult:errorCode:elapsed: 回调通知登录结果。

- (void)logout;
objectivec

登出 RTS 服务器。

调用本接口登出后，无法再调用消息相关的方法或收到相关回调。

注意
本地用户调用此方法登出后，会收到 rtcEngineOnLogout:rtsEngineOnLogout: 回调通知结果，远端用户不会收到通知。

- (void)updateLoginToken:(NSString * _Nonnull)token;
objectivec

更新用户用于登录的 Token

Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。

调用 login:uid: 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 rtcEngine:onLoginResult:errorCode:elapsed:rtsEngine:onLoginResult:errorCode:elapsed: 回调通知，错误码为 ByteRTCLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。

传入参数

注意

• 如果 Token 无效导致登录失败，则调用此方法更新 Token 后，SDK 会自动重新登录，而用户不需要自己调用 login:uid: 方法。
• Token 过期时，如果已经成功登录，则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时，或因本地网络状况不佳导致断网重新登录时通知给用户。

- (void)setServerParams:(NSString * _Nonnull)signature url:(NSString * _Nonnull)url;
objectivec

设置应用服务器参数

客户端调用 sendServerMessage: 或 sendServerBinaryMessage: 发送消息给应用服务器之前，必须需要设置有效签名和应用服务器地址。

传入参数

注意

• 用户必须调用 login:uid: 登录后，才能调用本接口。
• 调用本接口后，SDK 会使用 rtcEngine:onServerParamsSetResult:rtsEngine:onServerParamsSetResult: 返回相应结果。

- (void)getPeerOnlineStatus:(NSString * _Nonnull)peerUserId;
objectivec

查询本地/远端用户的登录状态。

传入参数

注意

• 必须调用 login:uid: 登录后，才能调用本接口。
• 调用本接口后，SDK 会使用 rtcEngine:onGetPeerOnlineStatus:status:rtsEngine:onGetPeerOnlineStatus:status: 回调通知查询结果。
• 在发送消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。

- (int64_t)sendMessage:(NSString * _Nonnull)userId message:(NSString * _Nonnull)messageStr config:(int)config;
objectivec

给指定的用户发送点对点文本消息（p2p）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RTS 引擎实例未创建
• -2：发送失败，userId 为空

注意

• 在发送点对点文本消息前，必须先调用 login:uid: 完成登录。
• 用户调用本接口发送文本信息后，会收到一次 rtcEngine:onUserMessageSendResultOutsideRoom:error:rtsEngine:onUserMessageSendResultOutsideRoom:error: 回调，得知消息是否成功发送；
• 若文本消息发送成功，则 userId 所指定的用户会通过 rtcEngine:onUserMessageReceivedOutsideRoom:message:rtsEngine:onUserMessageReceivedOutsideRoom:message: 回调收到该消息。

- (int64_t)sendBinaryMessage:(NSString * _Nonnull)userId message:(NSData * _Nonnull)messageStr config:(int)config;
objectivec

给指定的用户发送点对点二进制消息（p2p）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RTS 引擎实例未创建
• -2：发送失败，userId 为空

注意

• 在发送点对点二进制消息前，必须先调用 login:uid: 完成登录。
• 用户调用本接口发送二进制消息后，会收到一次 rtcEngine:onUserMessageSendResultOutsideRoom:error:rtsEngine:onUserMessageSendResultOutsideRoom:error: 回调，通知消息是否发送成功；
• 若二进制消息发送成功，则 userId 所指定的用户会通过 rtcEngine:onUserBinaryMessageReceivedOutsideRoom:message:rtsEngine:onUserBinaryMessageReceivedOutsideRoom:message: 回调收到该条消息。

- (int64_t)sendServerMessage:(NSString * _Nonnull)messageStr;
objectivec

客户端给应用服务器发送文本消息（P2Server）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RTS 引擎实例未创建

注意

• 在向应用服务器发送文本消息前，必须先调用 login:uid: 完成登录，随后调用 setServerParams:url: 设置应用服务器。
• 调用本接口后，会收到一次 rtcEngine:onServerMessageSendResult:error:message:rtsEngine:onServerMessageSendResult:error:message: 回调，通知消息发送方是否发送成功。
• 若文本消息发送成功，则之前调用 setServerParams:url: 设置的应用服务器会收到该条消息。

- (int64_t)sendServerBinaryMessage:(NSData * _Nonnull)messageStr;
objectivec

客户端给应用服务器发送二进制消息（P2Server）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RTS 引擎实例未创建

注意

• 在向应用服务器发送二进制消息前，先调用 login:uid: 完成登录，随后调用 setServerParams:url: 设置应用服务器。
• 调用本接口后，会收到一次 rtcEngine:onServerMessageSendResult:error:message:rtsEngine:onServerMessageSendResult:error:message: 回调，通知消息发送方发送成功或失败；
• 若二进制消息发送成功，则之前调用 setServerParams:url: 设置的应用服务器会收到该条消息。

@interface RTSRoom : NSObject
objectivec

- (void)destroy;
objectivec

销毁房间

注意
退出并销毁调用 createRoom: 所创建的房间。

- (void)setRTSRoomDelegate:(id<RTSRoomDelegate> _Nullable)roomDelegate;
objectivec

通过设置 RTSRoomDelegate 代理，可以监听此 RTSRoom 对象对应的回调事件。

传入参数

- (int)joinRoom;
objectivec

加入房间。

调用 createRoom: 创建房间后，可调用该方法进房，在房间内收发广播消息。

返回值
方法调用结果。

• 0: 成功
• -2: 已经在房间内。接口调用成功后，只要收到返回值为 0 ，且未调用 leaveRoom 成功，则再次调用进房接口时，无论填写的房间 ID 和用户 ID 是否重复，均触发此返回值。
• -3: room 为空

注意

• 你需在调用 login:uid: 登陆 RTS 服务器后再加入房间。
• 本地用户调用此方法加入房间成功后，会收到 rtsRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 rtsRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知。

- (int)leaveRoom;
objectivec

离开房间。

用户调用此方法离开房间，结束实时消息通信，释放所有通信相关的资源。

返回值
方法调用结果。

• 0: 方法调用成功
• < 0: 方法调用失败

注意

• 此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 rtsRoomOnLeaveRoom: 回调通知。
• 如果调用此方法后立即销毁引擎，SDK 将无法触发 rtsRoomOnLeaveRoom: 回调

- (int64_t)sendRoomMessage:(NSString * _Nonnull)message;
objectivec

给房间内的所有其他用户发送文本消息。

传入参数

返回值
这次发送消息的编号，从 1 开始递增。

注意

• 在发送房间内文本消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后会收到一次 rtcRoom:onRoomMessageSendResult:error:rtsRoom:onRoomMessageSendResult:error: 回调，通知消息发送方发送成功或失败；
• 若文本消息发送成功，则房间内远端用户会收到 rtcRoom:onRoomMessageReceived:message:rtsRoom:onRoomMessageReceived:message: 回调。

- (int64_t)sendRoomBinaryMessage:(NSData * _Nonnull)message;
objectivec

给房间内的所有其他用户发送二进制消息。

传入参数

返回值
这次发送消息的编号，从 1 开始递增。

注意

• 在房间内广播二进制消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后会收到一次 rtcRoom:onRoomMessageSendResult:error:rtsRoom:onRoomMessageSendResult:error: 回调，通知消息发送方发送成功或失败；
• 若二进制消息发送成功，则房间内所有用户会收到 rtcRoom:onRoomBinaryMessageReceived:message:rtsRoom:onRoomBinaryMessageReceived:message: 回调。