com.pano.rtc.api.RtcGroupManager接口 参考

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

类
interface	Callback
	RtcGroupManager 的回调函数，在使用 RtcGroupManager 之前必须要设置回调以获取事件通知。 更多...
class	GroupConfig
	分组配置参数，用于加入分组。 更多...
class	UserInfo
	分组成员信息。 更多...

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

详细描述

RtcGroupManager, 分组服务核心接口

成员函数说明

dismissGroup()

QResult com.pano.rtc.api.RtcGroupManager.dismissGroup

(

String

groupId

)

解散分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

inviteGroupUsers()

QResult com.pano.rtc.api.RtcGroupManager.inviteGroupUsers	(	String	groupId,
		long[]	users
	)

邀请用户加入分组。

参数

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

返回

• OK: 成功
• 其他: 失败

joinGroup()

QResult com.pano.rtc.api.RtcGroupManager.joinGroup	(	String	groupId,
		GroupConfig	config
	)

加入分组。

参数

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

返回

• OK: 成功
• 其他: 失败

leaveGroup()

QResult com.pano.rtc.api.RtcGroupManager.leaveGroup

(

String

groupId

)

离开分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

observeAllGroups()

QResult com.pano.rtc.api.RtcGroupManager.observeAllGroups

(

)

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

返回

• OK: 成功
• 其他: 失败

observeGroup()

QResult com.pano.rtc.api.RtcGroupManager.observeGroup

(

String

groupId

)

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

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

setCallback()

QResult com.pano.rtc.api.RtcGroupManager.setCallback

(

Callback

callback

)

设置分组服务的回调。

参数

callback

回调。

返回

• OK: 成功
• 其他: 失败

setDefaultGroup()

QResult com.pano.rtc.api.RtcGroupManager.setDefaultGroup

(

String

groupId

)

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

参数

groupId

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

返回

• OK: 成功
• 其他: 失败

subscribeGroup()

QResult com.pano.rtc.api.RtcGroupManager.subscribeGroup

(

String

groupId

)

订阅分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

unobserveAllGroups()

QResult com.pano.rtc.api.RtcGroupManager.unobserveAllGroups

(

)

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

返回

• OK: 成功
• 其他: 失败

unobserveGroup()

QResult com.pano.rtc.api.RtcGroupManager.unobserveGroup

(

String

groupId

)

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

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

unsubscribeGroup()

QResult com.pano.rtc.api.RtcGroupManager.unsubscribeGroup

(

String

groupId

)

取消订阅分组。

参数

groupId

分组标识。

返回

• OK: 成功
• 其他: 失败

---

该接口的文档由以下文件生成:

• RtcGroupManager.java