tencent::av::AVEndpoint类 参考

房间成员的封装类。 更多...

#include <av_endpoint.h>

类
struct	Info
	房间成员基本信息。 更多...

Public 类型
typedef void(*	RequestViewListCompleteCallback) (std::vector< std::string > identifier_list, std::vector< View > view_list, int32 result, void *custom_data)
	RequestViewList()的回调函数。 更多...
typedef void(*	CancelAllViewCompleteCallback) (int32 result, void *custom_data)
	CancelAllView()的回调函数。 更多...

Public 成员函数
virtual const std::string &	GetId () const =0
	获得房间成员的Id。 更多...
virtual const Info &	GetInfo () const =0
	获得房间成员的基本信息。 更多...
virtual bool	MuteAudio (bool is_mute=false)=0
	屏蔽成员语音。 更多...
virtual bool	IsAudioMute ()=0
	成员是否被屏蔽语音。 更多...
virtual bool	HasAudio ()=0
	判断成员是否音频上行。 更多...
virtual bool	HasCameraVideo ()=0
	判断成员是否有发来自摄像头或外部视频捕获设备的视频。 更多...
virtual bool	HasScreenVideo ()=0
	判断成员是否有发来自屏幕的视频。 更多...

Protected 成员函数
virtual	~AVEndpoint ()

详细描述

房间成员由房间动态创建和销毁，应用层无法直接创建房间成员，只能通过查询房间成员的方式获取成员对象引用。

备注

不建议应用程序缓存获得的成员对象引用，即显式地把成员对象引用保存到另一个容器。 这是由于随着成员加入和退出房间，房间内部会创建和销毁成员对象，这会导致缓存的引用失效。 任何时候，应该由房间提供的接口来获取成员对象。 当然，有时候为了简化代码，应用层还是需要保存一些必要信息方便进行操作，推荐您在响应房间成员变化的同时，把需要的信息复制到自己的容器，例如保存成员id。

成员类型定义说明

typedef void(* tencent::av::AVEndpoint::CancelAllViewCompleteCallback) (int32 result, void *custom_data)

该函数是CancelAllView的回调函数，用来异步返回启动结果。

参数

result	异步返回的错误码。 AV_OK 启动成功
custom_data	RequestViewList传入的custom_data。

typedef void(* tencent::av::AVEndpoint::RequestViewListCompleteCallback) (std::vector< std::string > identifier_list, std::vector< View > view_list, int32 result, void *custom_data)

该函数是RequestViewList的回调函数，用来异步返回启动结果。

参数

identifier_list	成员对象Id列表。
view_list	视频画面参数列表。
result	异步返回的错误码。 AV_OK 启动成功
custom_data	RequestViewList传入的custom_data。

构造及析构函数说明

virtual tencent::av::AVEndpoint::~AVEndpoint ( )

protectedvirtual

成员函数说明

virtual const std::string& tencent::av::AVEndpoint::GetId ( ) const

pure virtual

返回

返回房间成员的Id。

virtual const Info& tencent::av::AVEndpoint::GetInfo ( ) const

pure virtual

返回

返回房间成员的基本信息。

virtual bool tencent::av::AVEndpoint::HasAudio ( )

pure virtual

同步返回结果。1.0.0版本只支持在接收成员语音开启时，该接口才起作用，否则无效。

返回

true表示有音频上行，false表示无音频上行。

virtual bool tencent::av::AVEndpoint::HasCameraVideo ( )

pure virtual

同步返回结果。

返回

true表示有，false表示无。

virtual bool tencent::av::AVEndpoint::HasScreenVideo ( )

pure virtual

同步返回结果。

返回

true表示有，false表示无。

virtual bool tencent::av::AVEndpoint::IsAudioMute ( )

pure virtual

返回

true表示调用成功，false表示调用失败。

virtual bool tencent::av::AVEndpoint::MuteAudio ( bool  is_mute = false )

pure virtual

同步返回结果。屏蔽成员语音仅仅只是本地不解码、不播放，但是还是会接收音频数据。

参数

is_mute

是否屏蔽。

返回

true表示调用成功，false表示调用失败。