概览--实时音视频-火山引擎

文档中心

导航

概览

最近更新时间：2024.01.08 21:21:33首次发布时间：2022.09.14 20:26:33

IRTS

方法	描述
createRTSRoom	创建房间。多次调用此方法以创建多个 IRTSRoom 实例。分别调用各 IRTSRoom 实例中的 joinRoom 方法，同时加入多个房间。
login	登录即时消息服务器。调用此方法登录后，可以向同 `appID` 下其他已登录用户发送文本或二进制消息。
logout	登出 RTS 服务器。调用本接口登出后，无法再调用消息相关的方法或收到相关回调。
updateLoginToken	更新用户用于登录的 Token。 Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。
getPeerOnlineStatus	查询本地/远端用户的登录状态。在发送消息之前，你可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。
sendMessage	给指定的用户发送点对点文本消息（p2p）。
sendBinaryMessage	给指定的用户发送点对点二进制消息（p2p）。
setServerParams	设置应用服务器参数。客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给应用服务器之前，必须需要设置有效签名和应用服务器地址。
sendServerMessage	客户端给应用服务器发送文本消息（P2Server）。
sendServerBinaryMessage	客户端给应用服务器发送二进制消息（P2Server）。
setBusinessId	设置业务标识参数可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。
on	添加监听事件，并处理对应的函数。
off	取消事件监听。

IRTSRoom

方法	描述
joinRoom	加入房间。调用 createRTSRoom 创建房间后，可调用该方法进房，在房间内收发广播消息。
leaveRoom	离开房间。用户调用此方法离开房间，结束实时消息通信，释放所有通信相关的资源。
sendRoomMessage	给房间内的所有其他用户群发文本消息。
sendRoomBinaryMessage	给房间内的所有其他用户群发二进制消息。
on	添加监听事件，并处理对应的函数。
off	取消事件监听。
destroy	退出并销毁调用 createRTSRoom 所创建的房间。

IRTSRoomEvents

方法	描述
onUserJoined	远端用户首次进房，或断网后重新连入房间时，房间内其他用户将收到该事件。
onUserLeave	远端用户离开房间时，本地用户会收到此事件
onMessageReceived	接收到房间内广播消息的回调。房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。
onBinaryMessageReceived	接收到房间内广播二进制消息的回调。房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。

IRTSEvents

方法	描述
onMessageReceived	收到远端用户调用 sendMessage 发来的文本消息时，会收到此回调
onBinaryMessageReceived	收到远端用户调用 sendBinaryMessage 发来的二进制消息时，会收到此回调
onConnectionStateChanged	回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。
onWarning	发生警告回调。
onError	发生错误回调。
onServerParamsSetResult	设置应用服务器参数的返回结果

IVERTS

方法	描述
createRTS	创建引擎对象。如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTS 提供的各种消息能力。如果当前进程中已创建了引擎实例，再次调用此方法时，会创建另一个独立的引擎实例。
destroyRTS	销毁由 createRTS 所创建引擎实例，并释放所有相关资源。
getSdkVersion	获取 SDK 当前的版本号。