旁路直播设置布局

API 地址

api.yun.vhall.com/api/v1/inav/set-layout

描述

根据传入互动房间ID，重新渲染布局

入参

关于公共请求参数详细内容，请参考 公共请求参数。

常用模版说明 常用的模版有以下26种,选择常用模板布局无需传custom布局参数,选择CANVAS_LAYOUT_PATTERN_CUSTOM自定义布局是否混流布局有用户自己控制,请参数文档下方的布局参数进行布局

layout 布局常用模版参数

参数	类型	含义
CANVAS_LAYOUT_PATTERN_GRID_1	string	一人铺满
CANVAS_LAYOUT_PATTERN_GRID_2_H	string	左右两格
CANVAS_LAYOUT_PATTERN_GRID_3_E	string	正品字
CANVAS_LAYOUT_PATTERN_GRID_3_D	string	倒品字
CANVAS_LAYOUT_PATTERN_GRID_4_M	string	2行x2列
CANVAS_LAYOUT_PATTERN_GRID_5_D	string	2行，上3下2
CANVAS_LAYOUT_PATTERN_GRID_6_E	string	2行x3列
CANVAS_LAYOUT_PATTERN_GRID_9_E	string	3行x3列
CANVAS_LAYOUT_PATTERN_FLOAT_2_1DR	string	大屏铺满，小屏悬浮右下角
CANVAS_LAYOUT_PATTERN_FLOAT_2_1DL	string	大屏铺满，小屏悬浮左下角
CANVAS_LAYOUT_PATTERN_FLOAT_3_2DL	string	大屏铺满，2小屏悬浮左下角
CANVAS_LAYOUT_PATTERN_FLOAT_6_5D	string	大屏铺满，一行5个悬浮于下面
CANVAS_LAYOUT_PATTERN_FLOAT_6_5T	string	大屏铺满，一行5个悬浮于上面
CANVAS_LAYOUT_PATTERN_TILED_5_1T4D	string	主次平铺，一行4个位于底部
CANVAS_LAYOUT_PATTERN_TILED_5_1D4T	string	主次平铺，一行4个位于顶部
CANVAS_LAYOUT_PATTERN_TILED_5_1L4R	string	主次平铺，一列4个位于右边
CANVAS_LAYOUT_PATTERN_TILED_5_1R4L	string	主次平铺，一列4个位于左边
CANVAS_LAYOUT_PATTERN_TILED_6_1T5D	string	主次平铺，一行5个位于底部
CANVAS_LAYOUT_PATTERN_TILED_6_1D5T	string	主次平铺，一行5个位于顶部
CANVAS_LAYOUT_PATTERN_TILED_9_1L8R	string	主次平铺，右边为（2列x4行=8个块）
CANVAS_LAYOUT_PATTERN_TILED_9_1R8L	string	主次平铺，左边为（2列x4行=8个块）
CANVAS_LAYOUT_PATTERN_TILED_13_1L12R	string	主次平铺，右边为（3列x4行=12个块）
CANVAS_LAYOUT_PATTERN_TILED_17_1TL16GRID	string	主次平铺，1V16，主屏在左上角
CANVAS_LAYOUT_PATTERN_TILED_9_1D8T	string	主次平铺，主屏在下，8个（2行x4列）在上
CANVAS_LAYOUT_PATTERN_TILED_13_1TL12GRID	string	主次平铺，主屏在左上角，其余12个均铺于其他剩余区域
CANVAS_LAYOUT_PATTERN_TILED_17_1TL16GRID_E	string	主次平铺，主屏在左上角，其余16个均铺于其他剩余区域
CANVAS_LAYOUT_PATTERN_CUSTOM	string	自定义，当使用坐标布局接口时

自定义布局参数

注 : 请在画布边界内操作,超出画布大小设置本次不会生效,视频画面长宽缩放不能超过原视频的两倍

自定义位置参数的填写规则说明

横屏16:9 画布大小固定为1280 * 720

横屏4:3 画布大小固定为 1280 * 960

示意图：

注意事项:

位置参数 x、y 为小画面左上角相对背景画面左上角的绝对像素距离。

自定义布局格式

{
  "dpi": "480P",
  "frame_rate": 25,
  "bitrate": 1000,
  "background_color": "0x999999",
  "input_stream_list": [
    {
      "streamID": "558272227876559900",
      "location_params": {
        "width": 320,
        "height": 240,
        "x": 10,
        "y": 10,
        "alpha":1.0,
        "zorder": 0
      }
    },
    {
      "streamID": "597003735123980700",
      "location_params": {
        "width": 320,
        "height": 240,
        "x": 10,
        "y": 10,
        "alpha":1.0,
        "zorder": 0
      }
    }
  ]
}

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {}
}