| 方法 | 描述 |
|---|---|
| createRTS:delegate:parameters: | 创建引擎对象。 如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTS 提供的各种消息能力。 如果当前进程中已创建了引擎实例，再次调用此方法时，会创建另一个独立的引擎实例。 |
| destroyRTS | 销毁引擎实例对象。 |
| getSdkVersion | 获取 SDK 当前的版本号。 |
| setBusinessId: | 设置业务标识参数 可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。 |
| setRuntimeParameters: | 设置运行时的参数 |
| 方法 | 描述 |
|---|---|
| createRoom: | 创建房间实例。 调用此方法仅返回一个房间实例，你仍需调用 joinRoom 才能真正地创建/加入房间。 多次调用此方法以创建多个 RTSRoom 实例。分别调用各 RTSRoom 实例中的 joinRoom 方法，同时加入多个房间。 多房间模式下，用户可以同时订阅各房间的音视频流。 |
| destroy | 退出并销毁调用 createRoom: 所创建的房间实例。 |
| setRTSRoomDelegate: | 通过设置 RTSRoomDelegate 代理，可以监听此 RTSRoom 对象对应的回调事件。 |
| joinRoom | 加入房间。 调用 createRoom: 创建房间后，可调用该方法进房，在房间内收发广播消息。 |
| leaveRoom | 离开房间。 用户调用此方法离开房间，结束实时消息通信，释放所有通信相关的资源。 |
| 方法 | 描述 |
|---|---|
| sendRoomMessage: | 给房间内的所有其他用户发送文本消息。 |
| sendRoomBinaryMessage: | 给房间内的所有其他用户发送二进制消息。 |
| login:uid: | 登录 RTS 服务器。 必须先登录，才能收发消息。 在调用本接口登录后，如果想要登出，需要调用 logout |
| logout | 登出 RTS 服务器。 调用本接口登出后，无法再调用消息相关的方法或收到相关回调。 |
| updateLoginToken: | 更新用户用于登录的 Token Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。 调用 login:uid: 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 rtsEngine:onLoginResult:errorCode:elapsed: 回调通知，错误码为 ByteRTCLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。 |
| setServerParams:url: | 设置应用服务器参数 客户端调用 sendServerMessage: 或 sendServerBinaryMessage: 发送消息给应用服务器之前，必须需要设置有效签名和应用服务器地址。 |
| getPeerOnlineStatus: | 查询本地/远端用户的登录状态。 在发送消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。 |
| sendMessage:message:config: | 给指定的用户发送点对点文本消息（p2p） |
| sendBinaryMessage:message:config: | 给指定的用户发送点对点二进制消息（P2P）。 |
| sendServerMessage: | 客户端给应用服务器发送文本消息（P2Server）。 |
| sendServerBinaryMessage: | 客户端给应用服务器发送二进制消息（P2Server）。 |
| 方法 | 描述 |
|---|---|
| setLocalProxy: | 设置本地代理。 |
| 回调 | 描述 |
|---|---|
| rtsEngine:onSysStats: | 周期性（2s）地发出回调，报告当前 cpu 与内存的使用率 |
| 回调 | 描述 |
|---|---|
| rtsRoom:onRoomStateChanged:withUid:state:extraInfo: | 房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。 |
| rtsEngine:onCreateRoomStateChanged:errorCode: | 创建房间失败回调。 |
| rtsRoomOnLeaveRoom: | 离开房间成功回调。 用户调用 leaveRoom 方法后，SDK 会停止房间内消息的收发，并在释放所有相关资源后，通过此回调通知用户离开房间成功。 |
| rtsRoom:onUserJoined:elapsed: | 远端用户首次进房，或断网后重新连入房间时，房间内其他用户将收到该事件。 |
| rtsRoom:onUserLeave:reason: | 远端用户离开房间时，本地用户会收到此事件 |
| 回调 | 描述 |
|---|---|
| rtsRoom:onRoomMessageReceived:message: | 收到房间中调用 sendRoomMessage: 发送的广播文本消息时，收到此回调。 |
| rtsRoom:onRoomBinaryMessageReceived:message: | 收到房间中调用 sendRoomBinaryMessage: 发送的广播二进制消息时，收到此回调。 |
| rtsRoom:onRoomMessageSendResult:error: | 向房间内所有用户群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 |
| rtsEngine:onLoginResult:errorCode:elapsed: | 登录 RTS 服务器结果回调。 |
| rtsEngineOnLogout: | 登出结果回调 |
| rtsEngine:onServerParamsSetResult: | 设置应用服务器参数的返回结果 |
| rtsEngine:onGetPeerOnlineStatus:status: | 查询对端或本端用户登录状态的返回结果 |
| rtsEngine:onMessageReceived:message: | 收到远端用户调用 sendMessage:message:config: 发来的文本消息时，会收到此回调。 |
| rtsEngine:onBinaryMessageReceived:message: | 收到房间外用户调用 sendBinaryMessage:message:config: 发来的二进制消息时，会收到此回调。 |
| rtsEngine:onMessageSendResult:error: | 发送 p2p 消息的结果回调。 |
| rtsEngine:onServerMessageSendResult:error:message: | 发送 p2server 消息的结果回调。 |
| 回调 | 描述 |
|---|---|
| rtsEngine:onNetworkTypeChanged: | SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 |
| rtsEngine:onConnectionStateChanged: | SDK 与信令服务器连接状态改变回调。连接状态改变时触发。 |