AVDVideoMixer类 参考

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

类 AVDVideoMixer 继承关系图:

构造函数
(AVDResult)	- setMainVideo:
	切换混屏视频的主视频（若主视频掉线，本地主播视频切为主视频） 更多...
(AVDResult)	- autoLayoutParams:w:h:x_begin:y_begin:
	混屏视频自动布局的布局参数设置 更多...
(AVDResult)	- addSubVideo:
	添加视频到混屏视频特定位置 更多...
(AVDResult)	- addSubVideo:zorder:x:y:w:h:
(AVDResult)	- updateSubVideo:zorder:x:y:w:h:
	更新附加视频在混屏视频上显示的位置 更多...
(void)	- removeSubVideo:
	移除混屏视频上的某一视频 更多...
(void)	- clearSubVideos
	清理掉所有的混屏视频，包括主视频；如果需要再次开启合屏，需要重新设置混屏视频和Overlay视频。 更多...
((unavailable("init is not a supported initializer for this class.")	- __attribute__

属性
enum AVDMixerVideoLayoutType	layoutType
	各子视频在混屏视频中的布局类型 更多...
CGSize	mixerSize
	合屏视频图像宽,高 更多...
enum AVDScalingType	scaling
	视频合屏时采用的拉伸方式 更多...

详细描述

视频混屏模块接口.

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

函数文档

__attribute__()

- (( unavailable("init is not a supported initializer for this class.") __attribute__

addSubVideo:()

- (AVDResult) addSubVideo:

(AVDUserId)

userId

添加视频到混屏视频特定位置

参数

[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:zorder:x:y:w:h:()

- (AVDResult) addSubVideo:		(AVDUserId)	userId
zorder:		(NSUInteger)	zorder
x:		(CGFloat)	x
y:		(CGFloat)	y
w:		(CGFloat)	w
h:		(CGFloat)	h

autoLayoutParams:w:h:x_begin:y_begin:()

- (AVDResult) autoLayoutParams:		(BOOL)	isTopdown
w:		(CGFloat)	w
h:		(CGFloat)	h
x_begin:		(CGFloat)	x_begin
y_begin:		(CGFloat)	y_begin

混屏视频自动布局的布局参数设置

参数

[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()

- (void) clearSubVideos

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

返回

返回错误代码。

removeSubVideo:()

- (void) removeSubVideo:

(AVDUserId)

userId

移除混屏视频上的某一视频

参数

[in]

userId

摄像头Id，唯一标示一路共享的摄像头视频。

返回

返回错误代码。

setMainVideo:()

- (AVDResult) setMainVideo:

(AVDUserId)

userId

切换混屏视频的主视频（若主视频掉线，本地主播视频切为主视频）

参数

[in]

userId

摄像头Id，唯一标示一路共享的摄像头视频。

返回

返回错误代码。

注解

混屏视频的主视频在vl_auto_overlay模式下可以做切换，缺省为主播视频

updateSubVideo:zorder:x:y:w:h:()

- (AVDResult) updateSubVideo:		(AVDUserId)	userId
zorder:		(NSUInteger)	zorder
x:		(CGFloat)	x
y:		(CGFloat)	y
w:		(CGFloat)	w
h:		(CGFloat)	h

更新附加视频在混屏视频上显示的位置

参数

[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

返回

返回错误代码。

属性说明

layoutType

- (enum AVDMixerVideoLayoutType) layoutType

readwritenonatomicassign

各子视频在混屏视频中的布局类型

mixerSize

- (CGSize) mixerSize

readwritenonatomicassign

合屏视频图像宽,高

scaling

- (enum AVDScalingType) scaling

readwritenonatomicassign

视频合屏时采用的拉伸方式

---

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

• AVDVideoMixer.h