通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM C++ API Reference for Linux & Windows

概览 IRtmService IMessage SendMessageOptions PEER_SUBSCRIPTION_OPTION PeerOnlineStatus RtmAttribute IRtmChannelAttribute ChannelAttributeOptions AgoraRtmChannelMemberCount IChannel IChannelMember IRtmCallManager ILocalCallInvitation IRemoteCallInvitation IRtmServiceEventHandler IChannelEventHandler IRtmCallEventHandler 状态码和错误码

Public 成员函数

virtual int join ()=0
 
virtual int leave ()=0
 
virtual int sendMessage (const IMessage *message)=0
 
virtual int sendMessage (const IMessage *message, const SendMessageOptions &options)=0
 
virtual const char * getId () const =0
 
virtual int getMembers ()=0
 
virtual void release ()=0
 

Protected 成员函数

virtual ~IChannel ()
 

构造及析构函数说明

◆ ~IChannel()

virtual agora::rtm::IChannel::~IChannel ( )
inlineprotectedvirtual

成员函数说明

◆ join()

virtual int agora::rtm::IChannel::join ( )
pure virtual

加入频道。

注解
同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 JOIN_CHANNEL_ERR_FAILURE。
返回
  • 0: 方法调用成功。
  • ≠0: 方法调用失败。错误码详见 JOIN_CHANNEL_ERR 。

◆ leave()

virtual int agora::rtm::IChannel::leave ( )
pure virtual

离开频道。

  • 方法调用成功：
    • 本地用户收到回调 onLeave 的 LEAVE_CHANNEL_ERR_OK 状态。
    • 所有远端用户收到回调 onMemberLeft。
  • 方法调用失败：本地用户收到回调 onLeave的错误代码。错误代码信息详见 LEAVE_CHANNEL_ERR。
    返回
  • 0: 方法调用成功。
  • ≠0: 方法调用失败。错误码详见 LEAVE_CHANNEL_ERR 。

◆ sendMessage() [1/2]

virtual int agora::rtm::IChannel::sendMessage ( const IMessage *  message)
pure virtual
弃用:
供频道成员向所在频道发送频道消息。
注解
我们不推荐使用该方法发送频道消息。请改用它的重载方法 sendMessage 发送频道消息。

方法调用成功：

注解
（RTM SDK for Windows C++）发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 180 次。（RTM SDK for Linux C++）发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 1500 次。
参数
message发送的消息。 详见 IMessage。
返回

◆ sendMessage() [2/2]

virtual int agora::rtm::IChannel::sendMessage ( const IMessage *  message,
const SendMessageOptions &  options 
)
pure virtual

供频道成员向所在频道发送频道消息。

方法调用成功：

注解
（RTM SDK for Windows C++）发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 180 次。（RTM SDK for Linux C++）发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 1500 次。
参数
message发送的消息。 详见 IMessage。
options消息发送选项。详见 SendMessageOptions。
返回

◆ getId()

virtual const char* agora::rtm::IChannel::getId ( ) const
pure virtual

获取当前频道 ID。

返回
当前频道 ID。

◆ getMembers()

virtual int agora::rtm::IChannel::getMembers ( )
pure virtual

获取频道成员列表。

SDK 通过 onGetMembers 回调返回该方法的调用结果（频道成员列表）。

注解
该方法的调用频率上限为每 2 秒 5 次。该方法最多获取 512 个频道成员。如果频道成员数量超过 512，该方法会随机返回其中的 512 个成员。
返回
  • 0: 方法调用成功。
  • ≠0: 方法调用失败。错误码详见 GET_MEMBERS_ERR 。

◆ release()

virtual void agora::rtm::IChannel::release ( )
pure virtual

释放当前 IChannel 实例使用的所有资源。