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

视频混屏模块接口. 更多...

Public 成员函数

virtual Result setMixerTypeaSize (MixerVideoLayoutType layout, int width, int height)=0
 设置直播视频参数 更多...
 
virtual Result setScaleType (IVideoRenderView::ScalingType scale)=0
 设置直播视频合屏时采用的拉伸方式 更多...
 
virtual Result setBackgroud (const String &background)=0
 设置直播视频背景图片 更多...
 
virtual void clearSubVideos ()=0
 清理掉所有的混屏视频,包括主视频;如果需要再次开启合屏,需要重新设置直播视频和Overlay视频。 更多...
 
virtual Result setMainVideo (const UserId &userId)=0
 切换直播视频的主视频(若主视频掉线,本地主播视频切为主视频) 更多...
 
virtual Result autoLayoutParams (bool isTopdown, float w, float h, float x_begin, float y_begin)=0
 直播视频自动布局的布局参数设置 更多...
 
virtual Result addSubVideo (const UserId &userId)=0
 添加视频到直播视频特定位置 更多...
 
virtual Result addSubVideo (const UserId &userId, int zorder, float x, float y, float w, float h)=0
 
virtual Result updateSubVideo (const UserId &userId, int zorder, float x, float y, float w, float h)=0
 更新附加视频在直播视频上显示的位置 更多...
 
virtual void removeSubVideo (const UserId &userId)=0
 移除直播视频上的某一视频 更多...
 

Protected 成员函数

virtual ~IMVideoMixer ()
 

详细描述

视频混屏模块接口.

视频混屏模块定义房间中视频混屏、布局、订阅功能接口。

构造及析构函数说明

◆ ~IMVideoMixer()

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

成员函数说明

◆ addSubVideo() [1/2]

virtual Result tee3::avd::IMVideoMixer::addSubVideo ( const UserId userId)
pure virtual

添加视频到直播视频特定位置

参数
[in]userId摄像头Id,唯一标示一路共享的摄像头视频。
[in]zorder多个视频覆盖时,前后位置,zorder越小,视频越在前面,后面会被覆盖;取值0-n
[in]x此视频在直播视频的左上角左边位置,即x坐标,取值0.0~1.0,内部取值为:width (直播视频)x X
[in]y此视频在直播视频的左上角上边位置,即y坐标,取值0.0~1.0,内部取值为:height(直播视频)x Y
[in]w此视频在直播视频的宽度比例,取值0.0~1.0,内部取值为:width (直播视频)x W
[in]h此视频在直播视频的高度比例,取值0.0~1.0,内部取值为:height(直播视频)x H
返回
返回错误代码。
参见
addMixerOverlayVideo

◆ addSubVideo() [2/2]

virtual Result tee3::avd::IMVideoMixer::addSubVideo ( const UserId userId,
int  zorder,
float  x,
float  y,
float  w,
float  h 
)
pure virtual

◆ autoLayoutParams()

virtual Result tee3::avd::IMVideoMixer::autoLayoutParams ( bool  isTopdown,
float  w,
float  h,
float  x_begin,
float  y_begin 
)
pure virtual

直播视频自动布局的布局参数设置

参数
[in]isTopdown各子视频在直播视频上的排列顺序,true: 从上往下(左到右)排列; false: 从下往上(左到右)排列
[in]w各子视频相对直播视频的宽度比例,取值0.0~1.0,内部取值为:width (直播视频)x W
[in]h各子视频相对直播视频的高度比例,取值0.0~1.0,内部取值为:height(直播视频)x H
[in]x_begin初始子视频在直播视频的左上角左边位置,即x坐标,取值0.0~1.0,内部取值为:width (直播视频)x x_begin
[in]y_begin初始子视频在直播视频的左上角上边位置,即y坐标,取值0.0~1.0,内部取值为:height(直播视频)x y_begin
返回
返回错误代码。
注解
缺省设置为:vl_auto_overlay布局类型,从下往上排列; w=h=0.3f; x_begin=0.7f; y_begin=0.7f;

◆ clearSubVideos()

virtual void tee3::avd::IMVideoMixer::clearSubVideos ( )
pure virtual

清理掉所有的混屏视频,包括主视频;如果需要再次开启合屏,需要重新设置直播视频和Overlay视频。

返回
返回错误代码。

◆ removeSubVideo()

virtual void tee3::avd::IMVideoMixer::removeSubVideo ( const UserId userId)
pure virtual

移除直播视频上的某一视频

参数
[in]userId摄像头Id,唯一标示一路共享的摄像头视频。
返回
返回错误代码。

◆ setBackgroud()

virtual Result tee3::avd::IMVideoMixer::setBackgroud ( const String background)
pure virtual

设置直播视频背景图片

参数
[in]background直播背景图
返回
返回错误代码。

◆ setMainVideo()

virtual Result tee3::avd::IMVideoMixer::setMainVideo ( const UserId userId)
pure virtual

切换直播视频的主视频(若主视频掉线,本地主播视频切为主视频)

参数
[in]userId摄像头Id,唯一标示一路共享的摄像头视频。
返回
返回错误代码。
注解
直播视频的主视频在vl_auto_overlay模式下可以做切换,缺省为主播视频

◆ setMixerTypeaSize()

virtual Result tee3::avd::IMVideoMixer::setMixerTypeaSize ( MixerVideoLayoutType  layout,
int  width,
int  height 
)
pure virtual

设置直播视频参数

参数
[in]layout各子视频在直播视频中的布局类型
[in]width直播视频图像宽
[in]height直播视频图像高
返回
返回错误代码。

◆ setScaleType()

virtual Result tee3::avd::IMVideoMixer::setScaleType ( IVideoRenderView::ScalingType  scale)
pure virtual

设置直播视频合屏时采用的拉伸方式

参数
[in]scale各子视频合屏时采用的拉伸方式,参考ScaleType
返回
返回错误代码。

◆ updateSubVideo()

virtual Result tee3::avd::IMVideoMixer::updateSubVideo ( const UserId userId,
int  zorder,
float  x,
float  y,
float  w,
float  h 
)
pure virtual

更新附加视频在直播视频上显示的位置

参数
[in]userId摄像头Id,唯一标示一路共享的摄像头视频。
[in]zorder多个视频覆盖时,前后位置,zorder越小,视频越在前面,后面会被覆盖;取值0-n
[in]x此视频在直播视频的左上角左边位置,即x坐标,取值0.0~1.0,内部取值为:width (直播视频)x X
[in]y此视频在直播视频的左上角上边位置,即y坐标,取值0.0~1.0,内部取值为:height(直播视频)x Y
[in]w此视频在直播视频的宽度比例,取值0.0~1.0,内部取值为:width (直播视频)x W
[in]h此视频在直播视频的高度比例,取值0.0~1.0,内部取值为:height(直播视频)x H
返回
返回错误代码。

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