音视频通讯SDK API参考手册  Windows 1.6.0
tencent::av::AVRoomMulti类 参考abstract

多人音视频房间的封装类。 更多...

#include <av_room_multi.h>

类 tencent::av::AVRoomMulti 继承关系图:
tencent::av::AVRoom

struct  Delegate
 多人房间委托类,App需要实现其成员函数来响应房间成员变化。 更多...
 
struct  EnterRoomParam
 调用EnterRoom()进入多人房间时候的入参。 更多...
 

Public 成员函数

virtual int32 GetEndpointCount ()=0
 获得房间成员个数。 更多...
 
virtual int32 GetEndpointList (AVEndpoint **endpoints[])=0
 获得房间成员列表。 更多...
 
virtual AVEndpointGetEndpointById (const std::string &identifier)=0
 获得房间成员的AVEndpoint对象。 更多...
 
virtual int32 ChangeAuthority (const std::string &auth_buffer)=0
 更改自己在房间内的权限。 更多...
 
- Public 成员函数 继承自 tencent::av::AVRoom
virtual const InfoGetRoomInfo ()=0
 获得房间的配置信息。 更多...
 
virtual uint64 GetRoomId ()=0
 获得房间的id。 更多...
 
virtual RoomType GetRoomType ()=0
 获得房间的类型。 更多...
 
virtual std::string GetQualityTips ()=0
 获取通话中实时房间质量相关信息,业务侧可以不用关心,主要用来查看通话情况、排查问题等。 更多...
 
virtual void SetNetType (NetStateType type)=0
 设置当前网络类型。 更多...
 
virtual int32 RequestViewList (const std::vector< std::string > identifier_list, const std::vector< View > view_list, AVEndpoint::RequestViewListCompleteCallback complete_callback, void *custom_data)=0
 同时请求多个成员的视频画面。 更多...
 
virtual int32 CancelAllView (AVEndpoint::CancelAllViewCompleteCallback complete_callback, void *custom_data)=0
 取消所有请求的视频画面。 更多...
 

Protected 成员函数

virtual ~AVRoomMulti ()
 
- Protected 成员函数 继承自 tencent::av::AVRoom
virtual ~AVRoom ()
 

额外继承的成员函数

- Public 类型 继承自 tencent::av::AVRoom
enum  RoomType { ROOM_TYPE_NONE = 0, ROOM_TYPE_PAIR = 1, ROOM_TYPE_MULTI = 2 }
 音视频房间类型。 更多...
 
enum  Mode { MODE_AUDIO = 0, MODE_VIDEO = 1 }
 音视频通话模式。 更多...
 
enum  AudioCategory { AUDIO_CATEGORY_VOICECHAT = 0, AUDIO_CATEGORY_MEDIA_PLAY_AND_RECORD = 1, AUDIO_CATEGORY_MEDIA_PLAYBACK = 2 }
 音视场景策略。 更多...
 
enum  EndpointEventId {
  EVENT_ID_NONE = 0, EVENT_ID_ENDPOINT_ENTER = 1, EVENT_ID_ENDPOINT_EXIT = 2, EVENT_ID_ENDPOINT_HAS_CAMERA_VIDEO = 3,
  EVENT_ID_ENDPOINT_NO_CAMERA_VIDEO = 4, EVENT_ID_ENDPOINT_HAS_AUDIO = 5, EVENT_ID_ENDPOINT_NO_AUDIO = 6, EVENT_ID_ENDPOINT_HAS_SCREEN_VIDEO = 7,
  EVENT_ID_ENDPOINT_NO_SCREEN_VIDEO = 8
}
 成员事件id 更多...
 

详细描述

备注
要访问AVRoomMulti的成员函数,App需要先调用AVContext::GetRoom()获得AVRoom*类型的对象指针, 然后再使用AV_ROOM_MULTI帮助宏,把AVRoom*类型转换成AVRoomMulti*类型。代码片段如下:
AVRoomMulti* room = AV_ROOM_MULTI(av_context_->GetRoom());
if (room) {
room->...
}

构造及析构函数说明

virtual tencent::av::AVRoomMulti::~AVRoomMulti ( )
protectedvirtual

成员函数说明

virtual int32 tencent::av::AVRoomMulti::ChangeAuthority ( const std::string &  auth_buffer)
pure virtual

通话中动态修改自己的音视频上下行权限,用于第三方实现权限控制和管理。

参数
[in]auth_buffer权鉴加密串。
返回
返回操作结果。
virtual AVEndpoint* tencent::av::AVRoomMulti::GetEndpointById ( const std::string &  identifier)
pure virtual

帐号名(用户名)可以作为房间成员之间的唯一标识。 App可以通过此成员函数获得指定的AVEndpoint对象。

参数
identifier要获得的AVEndpoint对象的帐号名(用户名)。
返回
返回指定的AVEndpoint对象;出错时返回NULL。 返回值的生命周期由SDK控制,不需要App负责销毁。
备注
注意:SDK默认不支持获取房间内成员;由业务层自己维护房间成员列表。
virtual int32 tencent::av::AVRoomMulti::GetEndpointCount ( )
pure virtual

获取当前正在房间内的成员个数。

返回
成员个数。
备注
注意:SDK默认不支持获取房间内成员的个数;由业务层自己维护房间成员个数。
virtual int32 tencent::av::AVRoomMulti::GetEndpointList ( AVEndpoint **  endpoints[])
pure virtual

获取当前正在房间内的成员列表。

参数
[out]endpoints正在房间内的成员列表。
返回
成员个数,负数表示获取失败。
备注
注意:SDK默认不支持获取房间内成员列表的功能;由业务层自己维护房间成员列表。