互动直播连麦者画面自定义布局说明文档

442℃

为了满足真实场景下用户对于连麦者显示位置的需求,我们开发了互动直播连麦者画面自定义布局功能,开发者可以根据业务上的需求对背景画面、主播和连麦者位置做自定义的调整。

我们把整个画面分为基本属性、主播显示区域属性连麦者显示区域属性

 

基本属性的相关参数包括如下:

 

  • 版本号(version):画面布局参数校验规则的版本号。

 

  • 是否需要主播作为底部画面(set_host_as_main):整体的画面布局分为两种模式,一种是主播和连麦者并列布局在画布上(参数设为false),另一种是连麦者布局在主播画面上(参数设为ture),一旦采取此种布局方式,画布宽度、画布高度和画布背景色都无效。

 

  • 画布宽度(main_widht):定义背景画布的宽度,单位是像素(pixel)

 

  • 画布高度(main_height):定义背景画布的高度,单位是像素(pixel)

 

  • 连麦者数目(n_host_area_number):定义连麦者的数量。

 

  • 画布背景色(rgb_r、rgb_g、rgb_b):定义背景画布的颜色。

 

  • 连麦者位置是否需要自适应(special_show_mode):该参数定义了当连麦者退出房间时,房间内剩余的连麦者是否需要自适应改变连麦位置。参数为false则自适应,在连麦者进出房间时,房间内的连麦者会自适应改变自己的位置。参数为true则不自适应,在连麦者进出房间时,房间内的连麦者不会自适应改变自己的位置。

 

主播显示区域属性的相关参数包括如下:

  • 横向坐标(position_x):定义主播显示区域的横向位置,主播显示区域左上角距离画布左边距离和画布宽度的比值,使用万分比

 

  • 纵向坐标(position_y):定义主播显示区域的纵向位置,主播显示区域左上角距离画布上边距离和画布高度的比值,使用万分比

 

  • 画面宽度(width_rate):定义主播显示区域的宽度,主播显示区域宽度和画布宽度的比值,使用万分比

 

  • 画面高度(height_rate):定义主播显示区域的高度,主播显示区域高度和画布高度的比值,使用万分比

 

  • 展示方式(adaption):选择主播画面是以裁剪或是缩放的方式在画面指定区域展示。

 

连麦者显示区域属性的相关参数包括如下:

  • 横向坐标(position_x):定义连麦者显示区域的横向位置,连麦者显示区域左上角距离画布左边距离和画布宽度的比值,使用万分比

 

  • 纵向坐标(position_y):定义连麦者显示区域的纵向位置,连麦者显示区域左上角距离画布上边距离和画布高度的比值,使用万分比

 

  • 画面宽度(width_rate):定义连麦者显示区域的宽度,连麦者显示区域宽度和画布宽度的比值,使用万分比

 

  • 画面高度(height_rate):定义连麦者显示区域的高度,连麦者显示区域高度和画布高度的比值,使用万分比

 

  • 展示方式(adaption):选择连麦者画面是以裁剪或是缩放的方式在画面指定区域展示。

 

 

同时我们提供了一个参数校验工具,帮助开发者校验参数有效性并快速看到布局效果图。