PanoGroup类 参考

PanoGroup, 分组服务核心接口 更多...

#include <PanoGroup.h>

类
class	Callback
	PanoGroup 的回调函数，在使用 PanoGroup 之前必须要设置回调以获取事件通知。 更多...
struct	JoinParams
	分组配置参数，用于加入分组 更多...

Public 类型
enum class	State { Idle , Joined , Error }

Public 成员函数
virtual QResult	setCallback (Callback *callback)=0
	设置分组服务的回调。 更多...
virtual QResult	joinGroup (const char *groupId, const JoinParams &param)=0
	加入分组。 更多...
virtual QResult	subscribeGroup (const char *groupId)=0
	订阅分组。 更多...
virtual QResult	unsubscribeGroup (const char *groupId)=0
	取消订阅分组。 更多...
virtual QResult	leaveGroup (const char *groupId)=0
	离开分组。 更多...
virtual QResult	inviteGroupUsers (const char *groupId, uint64_t *users, int count)=0
	邀请用户加入分组。 更多...
virtual QResult	dismissGroup (const char *groupId)=0
	解散分组。 更多...
virtual QResult	setDefaultGroup (const char *groupId)=0
	设置默认分组。在音频自动订阅启用的情况下，默认分组设置后新用户加入频道会自动加入和订阅默认分组。 更多...
virtual QResult	observeGroup (const char *groupId)=0
	观察指定分组的事件。调用成功后可在未加入分组的情况下接收分组事件。 更多...
virtual QResult	unobserveGroup (const char *groupId)=0
	取消观察指定分组的事件。 更多...
virtual QResult	observeAllGroups ()=0
	观察所有分组的事件，包括后续创建的分组。调用成功后可在未加入分组的情况下接收分组事件。 更多...
virtual QResult	unobserveAllGroups ()=0
	取消观察所有分组的事件。 更多...

详细描述

PanoGroup, 分组服务核心接口

成员函数说明

dismissGroup()

virtual QResult PanoGroup::dismissGroup ( const char *  groupId )

pure virtual

解散分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

inviteGroupUsers()

virtual QResult PanoGroup::inviteGroupUsers ( const char *  groupId, uint64_t *  users, int  count  )

pure virtual

邀请用户加入分组。

参数

groupId	分组标识。
users	受邀用户列表。
count	用户列表长度。

返回

• OK: 成功
• 其他: 失败

joinGroup()

virtual QResult PanoGroup::joinGroup ( const char *  groupId, const JoinParams &  param  )

pure virtual

加入分组。

参数

groupId	分组标识。最大长度是128字节。
param	分组配置参数

返回

• OK: 成功
• 其他: 失败

leaveGroup()

virtual QResult PanoGroup::leaveGroup ( const char *  groupId )

pure virtual

离开分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

observeAllGroups()

virtual QResult PanoGroup::observeAllGroups ( )

pure virtual

观察所有分组的事件，包括后续创建的分组。调用成功后可在未加入分组的情况下接收分组事件。

返回

• OK: 成功
• 其他: 失败

observeGroup()

virtual QResult PanoGroup::observeGroup ( const char *  groupId )

pure virtual

观察指定分组的事件。调用成功后可在未加入分组的情况下接收分组事件。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

setCallback()

virtual QResult PanoGroup::setCallback ( Callback *  callback )

pure virtual

设置分组服务的回调。

参数

callback

回调。

返回

• OK: 成功
• 其他: 失败

setDefaultGroup()

virtual QResult PanoGroup::setDefaultGroup ( const char *  groupId )

pure virtual

设置默认分组。在音频自动订阅启用的情况下，默认分组设置后新用户加入频道会自动加入和订阅默认分组。

参数

groupId

默认分组标识。最大长度是128字节。置空为取消默认分组设置。

返回

• OK: 成功
• 其他: 失败

subscribeGroup()

virtual QResult PanoGroup::subscribeGroup ( const char *  groupId )

pure virtual

订阅分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

unobserveAllGroups()

virtual QResult PanoGroup::unobserveAllGroups ( )

pure virtual

取消观察所有分组的事件。

返回

• OK: 成功
• 其他: 失败

unobserveGroup()

virtual QResult PanoGroup::unobserveGroup ( const char *  groupId )

pure virtual

取消观察指定分组的事件。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

unsubscribeGroup()

virtual QResult PanoGroup::unsubscribeGroup ( const char *  groupId )

pure virtual

取消订阅分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

---

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

• PanoGroup.h