agora::rtc::IVideoMixerSource类 参考

abstract

IVideoMixerSource 类是一个多输入多输出视频源，可以从本地或远端接收多个视频轨道，并根据指定格式生成混合流。

成员函数说明

addImageSource()

virtual int agora::rtc::IVideoMixerSource::addImageSource ( const char *  id, const MixerLayoutConfig &  config, ImageType  type = kPng, aosl_ref_t  ares = AOSL_REF_INVALID  )

向流添加图像源。

参数

参数名	描述
id	流 ID。
config	布局配置。
type	图像类型。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

addVideoTrack()

virtual int agora::rtc::IVideoMixerSource::addVideoTrack ( const char *  id, agora_refptr< IVideoTrack >  track, aosl_ref_t  ares = AOSL_REF_INVALID  )

向流增加视频轨道。

参数

参数名	描述
id	流 ID。
track	用于合图的视频轨道。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

clearLayout()

virtual int agora::rtc::IVideoMixerSource::clearLayout ( aosl_ref_t  ares = AOSL_REF_INVALID )

删除全部布局设置。

参数

参数名	描述
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

delImageSource()

virtual int agora::rtc::IVideoMixerSource::delImageSource ( const char *  id, aosl_ref_t  ares = AOSL_REF_INVALID  )

删除图像源。

参数

参数名	描述
id	流 ID。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

delStreamLayout()

virtual int agora::rtc::IVideoMixerSource::delStreamLayout ( const char *  id, aosl_ref_t  ares = AOSL_REF_INVALID  )

删除视频布局。

参数

参数名	描述
id	流 ID。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

getAvgMixerDelay()

virtual int agora::rtc::IVideoMixerSource::getAvgMixerDelay ( )

获取合图模块造成的平均延迟（ms），包括合图功能延迟和编码器延迟。

返回值

平均延迟（ms）

refresh()

virtual int agora::rtc::IVideoMixerSource::refresh ( aosl_ref_t  ares = AOSL_REF_INVALID )

刷新布局。

参数

参数名	描述
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

removeVideoTrack()

virtual int agora::rtc::IVideoMixerSource::removeVideoTrack ( const char *  id, agora_refptr< IVideoTrack >  track, aosl_ref_t  ares = AOSL_REF_INVALID  )

从流中删除视频轨道。

参数

参数名	描述
id	流 ID。
track	需要删除的视频轨道。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

setBackground() [1/2]

virtual int agora::rtc::IVideoMixerSource::setBackground ( uint32_t  width, uint32_t  height, int  fps, const char *  url, aosl_ref_t  ares = AOSL_REF_INVALID  )

设置合图背景图片。

参数

参数名	描述
width	画布宽度（px）。
height	画布高度（px）。
fps	混合视频流的 fps。
url	背景图片 URL。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

setBackground() [2/2]

virtual int agora::rtc::IVideoMixerSource::setBackground ( uint32_t  width, uint32_t  height, int  fps, uint32_t  color_argb = 0, aosl_ref_t  ares = AOSL_REF_INVALID  )

设置合图背景。

参数

参数名	描述
width	画布宽度（px）。
height	画布高度（px）。
fps	混合视频流的 fps。
color_argb	背景色（argb）。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

setRotation()

virtual int agora::rtc::IVideoMixerSource::setRotation ( uint8_t  rotation, aosl_ref_t  ares = AOSL_REF_INVALID  )

设置合图旋转角度。

参数

参数名	描述
rotation	旋转角度。 0:无 1:90° 2:180° 3:270°
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。

setStreamLayout()

virtual int agora::rtc::IVideoMixerSource::setStreamLayout ( const char *  id, const MixerLayoutConfig &  config, aosl_ref_t  ares = AOSL_REF_INVALID  )

配置流中的视频布局。

参数

参数名	描述
id	流 ID。
config	布局配置。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

• 0: 成功。
• <0: 失败。