RtcMessage类 参考

RtcMessage, 消息服务核心接口 更多...

#include <PanoRtcMessage.h>

类
class	Callback
	RtcMessage的回调函数，在使用RtcMessage之前必须要设置回调以获取事件通知。 更多...

Public 类型
enum class	State { Unavailable , Available }
	消息服务状态。 更多...

Public 成员函数
virtual QResult	setCallback (Callback *callback)=0
	设置消息服务的回调。 更多...
virtual QResult	sendMessage (uint64_t userId, PanoData data)=0
	发送消息给指定用户。 更多...
virtual QResult	broadcastMessage (PanoData data, bool sendBack=false)=0
	广播消息。 更多...
virtual QResult	publish (const char *topic, PanoData data, uint32_t requestId=0)=0
	发布一个主题。 更多...
virtual QResult	subscribe (const char *topic)=0
	订阅一个主题。 更多...
virtual QResult	unsubscribe (const char *topic)=0
	取消订阅一个主题。 更多...
virtual QResult	setProperty (const char *name, PanoData value)=0
	设置或更新消息服务属性 更多...

详细描述

RtcMessage, 消息服务核心接口

成员枚举类型说明

State

enum class RtcMessage::State

strong

消息服务状态。

枚举值
Unavailable	消息服务不可用。
Available	消息服务可用。

成员函数说明

broadcastMessage()

virtual QResult RtcMessage::broadcastMessage ( PanoData  data, bool  sendBack = false  )

pure virtual

广播消息。

参数

data	二进制形式的消息数据
sendBack	是否回发消息

返回

• OK: 成功
• 其他: 失败

注解

发送消息的调用频率上限为每 3 秒 150 次。 请确保二进制消息大小不超过 4 KB。

publish()

virtual QResult RtcMessage::publish ( const char *  topic, PanoData  data, uint32_t  requestId = 0  )

pure virtual

发布一个主题。

参数

topic	主题标识。
data	主题数据。
requestId	请求标识。发布消息失败通过 onPublishTopicMessageFailed 返回。

返回

• OK: 成功
• 其他: 失败

注解

发送消息的调用频率上限为每 3 秒 150 次。 请确保主题标识长度不超过 128 B，二进制消息大小不超过 4 KB。

sendMessage()

virtual QResult RtcMessage::sendMessage ( uint64_t  userId, PanoData  data  )

pure virtual

发送消息给指定用户。

参数

userId	用户标识。
data	二进制形式的消息数据

返回

• OK: 成功
• 其他: 失败

注解

发送消息的调用频率上限为每 3 秒 150 次。 请确保二进制消息大小不超过 4 KB。

setCallback()

virtual QResult RtcMessage::setCallback ( Callback *  callback )

pure virtual

设置消息服务的回调。

参数

callback

回调。

返回

• OK: 成功
• 其他: 失败

setProperty()

virtual QResult RtcMessage::setProperty ( const char *  name, PanoData  value  )

pure virtual

设置或更新消息服务属性

参数

name	属性名字。
value	属性值。如果value的data域为空，或者size域为0，则此属性会被删除

返回

• OK: 调用成功
• others: 调用失败

注解

请确保属性名字长度不超过 128 B，二进制消息大小不超过 4 KB。

subscribe()

virtual QResult RtcMessage::subscribe ( const char *  topic )

pure virtual

订阅一个主题。

参数

topic

主题标识。

返回

• OK: 成功
• 其他: 失败

unsubscribe()

virtual QResult RtcMessage::unsubscribe ( const char *  topic )

pure virtual

取消订阅一个主题。

参数

topic

主题标识。

返回

• OK: 成功
• 其他: 失败

---

该类的文档由以下文件生成:

• PanoRtcMessage.h