logo
当前页

UpdateLayout

POST

https://cloudrecord-api.zego.im/

在录制过程中,可以随时调用本接口更改混流布局的设置。

说明
调用频率限制:10 次/秒

Request

Query Parameters

    Action string必填

    可选值: [UpdateLayout]

    接口原型参数

    https://cloudrecord-api.zego.im?Action=UpdateLayout

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    TaskId string必填

    录制任务 ID,长度固定为 16 个字节的字符串。

    MixMode integer

    可选值: [1, 2, 3, 4, 5]

    默认值: 2

    布局方式。

    • 1:自定义布局,必须指定 MixInputList
    • 2:平分布局(默认值)
    • 3:水平布局
    • 4:垂直布局
    • 5:悬浮布局
    MixInputList object[]
    自定义布局参数。
  • Array[
  • StreamId string

    指定在该画面显示的 streamID,如果未指定,会按照流加入房间的时间顺序进行匹配。

    ViewType integer

    可选值: [1, 2]

    默认值: 1

    该画面显示内容的类型。

    • 1:音视频(默认值)
    • 2:白板

    类型 2 仅在开启白板录制时有效,仅支持将一个画面设置为白板,超过两个及以上会返回错误。

    Top integer必填

    可选值: >= 0 and <= 1920

    画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过 Bottom 的值和画布的高。

    Left integer必填

    可选值: >= 0 and <= 1920

    画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过 Right 的值和画布的宽。

    Bottom integer必填

    可选值: >= 0 and <= 1920

    画布上该画面右下角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。

    Right integer必填

    可选值: >= 0 and <= 1920

    画布上该画面右下角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。

    Layer integer必填

    该画面的图层优先级,当两个画面发生重叠时,数值大的显示在上方。

    FillMode integer

    可选值: [1, 2]

    默认值: 1

    实际视频流宽高比与画面不一致时的处理方式。

    • 1:裁剪模式,该模式下优先保证画面被填满,原视频等比缩放填满画面后,四周超出画面的内容会被裁剪。(默认值)
    • 2:缩放模式,该模式下优先保证原视频的完整性,原视频等比缩放填满画面后,四周会补一圈黑边。
    BackgroundImage string

    流画面背景图的 URL 地址,仅当指定了 [StreamId] 参数时生效。自定义布局指定的流不存在或者流中断时会显示该背景图。

    • 建议背景图的分辨率与流画面分辨率一致,如两者分辨率不一致,背景图会被拉伸或压缩以填满整个画面。
    • 背景图格式支持 JPG 和 PNG,大小不能超过 5MB,如背景图下载失败,则设置不生效。
    • URL 支持 HTTP 和 HTTPS 协议。
  • ]
  • MixMaxResolutionStreamId string

    MixMode 设为 3、4、5 时,用于指定显示大画面的流 ID。

Responses

OK
Schema
    Code int64

    错误码。

    Message string

    错误描述。

    RequestId string

    请求 ID。

上一篇

结束录制

下一篇

更新白板

当前页

返回到顶部