cn.tee3.avd_SDK-C++  2.1.0
| Public 成员函数 | 静态 Public 成员函数 | Protected 成员函数 | 所有成员列表
tee3::avd::IMScreen类 参考abstract

房间中屏幕窗口共享模块接口. 更多...

类 tee3::avd::IMScreen 继承关系图:
tee3::avd::IModule

class  IListener
 房间中屏幕窗口共享模块回调接口. 更多...
 

Public 成员函数

virtual Result setListener (IListener *listener)=0
 设置房间屏幕窗口共享模块回调接口 更多...
 
virtual Result previewScreen (const ScreenWindow &device, IVideoRender *render)=0
 预览共享屏幕窗口视频 更多...
 
virtual Result unpreviewScreen ()=0
 取消预览共享屏幕窗口视频 更多...
 
virtual Result publishScreen (const ScreenWindow &screen)=0
 发布共享屏幕窗口视频 更多...
 
virtual Result publishScreen (ScreenWindow &fakeDevice, FakeVideoCapturer *capture)=0
 发布模拟屏幕窗口视频 更多...
 
virtual Result unpublishScreen ()=0
 取消发布共享屏幕视频 更多...
 
virtual Result swithToScreen (const DeviceId &deviceId)=0
 共屏屏幕窗口视频切换另外一屏幕窗口 更多...
 
virtual Result updateScreenData (const DeviceId &deviceId, int level, const String &description)=0
 共屏屏幕窗口数据更改 更多...
 
virtual Result subscribe (const DeviceId &deviceId)=0
 订阅共屏屏幕窗口视频 更多...
 
virtual Result unsubscribe (const DeviceId &deviceId)=0
 取消订阅共屏屏幕窗口视频 更多...
 
virtual Result getPublishedScreens (ScreensType &items) const =0
 获取已共享屏幕窗口信息 更多...
 
virtual Result getSubscribedScreens (ScreensType &items) const =0
 获取已订阅屏幕窗口信息 更多...
 
virtual bool isScreenSubscribed (const DeviceId &fromId) const =0
 判断屏幕窗口是否已经被本用户订阅 更多...
 
virtual Result attachRender (const DeviceId &deviceId, IVideoRender *render)=0
 render screen 更多...
 
virtual Result detachRender (const DeviceId &deviceId)=0
 解除屏幕窗口视频的所有显示对象关联 更多...
 
virtual Result detachRender (IVideoRender *render)=0
 解除某一显示对象与屏幕窗口视频的关联 更多...
 
virtual Result getScreenWindows (ScreensType &items)=0
 screen manager 更多...
 
- Public 成员函数 继承自 tee3::avd::IModule
virtual IRoomgetRoom ()=0
 获取房间接口指针 更多...
 
virtual IMUserManagergetUserManager ()=0
 获取房间用户管理模块指针 更多...
 
virtual bool isSelfUser (const UserId &userId) const =0
 判断是否是自己的用户Id 更多...
 
virtual bool isSelfDevice (const DeviceId &deviceId) const =0
 判断设备Id是否是属于自己的 更多...
 
virtual const UserId getOwnerId (const DeviceId &deviceId) const =0
 获取设备Id的关联用户Id 更多...
 
virtual const StringgetOwnerName (const DeviceId &deviceId) const =0
 获取设备Id的关联用户名称 更多...
 

静态 Public 成员函数

static IMScreengetScreen (IRoom *room)
 获取房间内屏幕窗口共享模块接口 更多...
 

Protected 成员函数

virtual ~IMScreen ()
 
- Protected 成员函数 继承自 tee3::avd::IModule
virtual ~IModule ()
 

详细描述

房间中屏幕窗口共享模块接口.

房间屏幕窗口共享模块定义房间中屏幕窗口共享相关功能接口。

构造及析构函数说明

◆ ~IMScreen()

virtual tee3::avd::IMScreen::~IMScreen ( )
protectedvirtual

成员函数说明

◆ attachRender()

virtual Result tee3::avd::IMScreen::attachRender ( const DeviceId deviceId,
IVideoRender render 
)
pure virtual

render screen

关联共享的屏幕窗口视频数据和显示对象,在render中显示视频

参数
[in]deviceId屏幕窗口Id,唯一标示一路共享的屏幕窗口视频。
[in]*render显示对象接口指针。
注解
视频数据可以在多个显示对象上显示,而一个显示对象某一时刻只能显示一路视频。 在屏幕窗口视频发布到房间中,或者远端屏幕窗口视频订阅成功后,调用此接口完成视频与显示对象的对接,从而在显示对象中显示视频。
返回
返回错误代码。
参见
IVideoRender

◆ detachRender() [1/2]

virtual Result tee3::avd::IMScreen::detachRender ( const DeviceId deviceId)
pure virtual

解除屏幕窗口视频的所有显示对象关联

参数
[in]deviceId屏幕窗口Id,唯一标示一路共享的屏幕窗口视频。
返回
返回错误代码。
参见
IVideoRender

◆ detachRender() [2/2]

virtual Result tee3::avd::IMScreen::detachRender ( IVideoRender render)
pure virtual

解除某一显示对象与屏幕窗口视频的关联

参数
[in]*render显示对象接口指针。
参见
IVideoRender

◆ getPublishedScreens()

virtual Result tee3::avd::IMScreen::getPublishedScreens ( ScreensType items) const
pure virtual

获取已共享屏幕窗口信息

参数
[in,out]items屏幕窗口集合存放列表。
返回
返回错误代码。

◆ getScreen()

static IMScreen* tee3::avd::IMScreen::getScreen ( IRoom room)
static

获取房间内屏幕窗口共享模块接口

参数
[in]room房间对象指针。
返回
返回屏幕窗口共享模块接口指针。

◆ getScreenWindows()

virtual Result tee3::avd::IMScreen::getScreenWindows ( ScreensType items)
pure virtual

screen manager

获取本机屏幕窗口信息列表

参数
[in,out]items屏幕窗口集合存放列表。
返回
返回错误代码。

◆ getSubscribedScreens()

virtual Result tee3::avd::IMScreen::getSubscribedScreens ( ScreensType items) const
pure virtual

获取已订阅屏幕窗口信息

参数
[in,out]items屏幕窗口集合存放列表。
返回
返回错误代码。

◆ isScreenSubscribed()

virtual bool tee3::avd::IMScreen::isScreenSubscribed ( const DeviceId fromId) const
pure virtual

判断屏幕窗口是否已经被本用户订阅

参数
[in]fromId屏幕窗口Id。
返回
返回是否是已订阅屏幕窗口。

◆ previewScreen()

virtual Result tee3::avd::IMScreen::previewScreen ( const ScreenWindow device,
IVideoRender render 
)
pure virtual

预览共享屏幕窗口视频

参数
[in]device屏幕窗口信息。
[in]render屏幕窗口信息。
返回
返回错误代码。

◆ publishScreen() [1/2]

virtual Result tee3::avd::IMScreen::publishScreen ( const ScreenWindow screen)
pure virtual

发布共享屏幕窗口视频

参数
[in]screen屏幕窗口信息,用户可以在信息结构的level和description字段中放置应用层逻辑数据,方便视频描述和订阅。
返回
返回错误代码。
注解
发布操作为异步操作,操作结果在 onPublishScreenResult 中返回。
参见
onPublishScreenResult

◆ publishScreen() [2/2]

virtual Result tee3::avd::IMScreen::publishScreen ( ScreenWindow fakeDevice,
FakeVideoCapturer capture 
)
pure virtual

发布模拟屏幕窗口视频

参数
[in,out]fakeDevice模拟屏幕窗口信息,接口会生成deviceId,生成规则:"userId_"+(用户输入的deviceId), 此处deviceId不能包含'_'和'{'、'}'此三个字符。
[in]*capture模拟屏幕窗口视频输入接口。
返回
返回错误代码。
注解
发布操作为异步操作,操作结果在 onPublishLocalResult 中返回。 模拟屏幕窗口用于在房间中导入特定已经存在的视频数据流作为共享屏幕,比如视频文件、录播系统视频流等。
参见
onPublishLocalResult
FakeVideoCapturer

◆ setListener()

virtual Result tee3::avd::IMScreen::setListener ( IListener listener)
pure virtual

设置房间屏幕窗口共享模块回调接口

参数
[in]*listener远程屏幕窗口共享模块回调接口指针。
返回
返回错误代码。
参见
IListener

◆ subscribe()

virtual Result tee3::avd::IMScreen::subscribe ( const DeviceId deviceId)
pure virtual

订阅共屏屏幕窗口视频

参数
[in]deviceId屏幕窗口Id,唯一标示一路共享的屏幕窗口视频。
返回
返回错误代码。
注解
订阅操作为异步操作,操作结果在 onSubscribeResult 中返回。
参见
onSubscribeResult

◆ swithToScreen()

virtual Result tee3::avd::IMScreen::swithToScreen ( const DeviceId deviceId)
pure virtual

共屏屏幕窗口视频切换另外一屏幕窗口

参数
[in]deviceId屏幕窗口Id。
返回
返回错误代码。

◆ unpreviewScreen()

virtual Result tee3::avd::IMScreen::unpreviewScreen ( )
pure virtual

取消预览共享屏幕窗口视频

返回
返回错误代码。

◆ unpublishScreen()

virtual Result tee3::avd::IMScreen::unpublishScreen ( )
pure virtual

取消发布共享屏幕视频

返回
返回错误代码。
注解
取消发布操作为异步操作,操作结果在 onUnpublishScreenResult 中返回。
参见
onUnpublishScreenResult

◆ unsubscribe()

virtual Result tee3::avd::IMScreen::unsubscribe ( const DeviceId deviceId)
pure virtual

取消订阅共屏屏幕窗口视频

参数
[in]deviceId屏幕窗口Id,唯一标示一路共享的屏幕窗口视频。
返回
返回错误代码。
注解
取消订阅操作为异步操作,操作结果在 onUnsubscribeResult 中返回。
参见
onUnsubscribeResult

◆ updateScreenData()

virtual Result tee3::avd::IMScreen::updateScreenData ( const DeviceId deviceId,
int  level,
const String description 
)
pure virtual

共屏屏幕窗口数据更改

参数
[in]deviceId屏幕窗口Id,唯一标示一个屏幕窗口。
[in]level屏幕窗口整形数据。
[in]description屏幕窗口字符串数据。
参见
onScreenDataNotify

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