You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/直播垫片/UpdateLivePadPreset - 更新直播垫片配置
UpdateLivePadPreset - 更新直播垫片配置
最近更新时间：2025.05.28 15:48:43首次发布时间：2025.05.28 15:48:43
我的收藏
有用
有用
无用
无用

调用 UpdateLivePadPreset 接口更新直播垫片配置模板，支持配置垫片类型、断流等待时间、垫片时长以及垫片素材地址或图像数据。通过该接口，您可以灵活设置直播中断时的替代内容，提升观众体验。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=UpdateLivePadPreset&Version=2023-01-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是UpdateLivePadPreset接口名称。当前 API 的名称为 UpdateLivePadPreset。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
PresetNameString是default_preset待更新的垫片模板名称。
DescriptionString否默认垫片配置垫片模板的描述信息，用于详细说明该模板的用途或特性，最大长度为 1024 字节。

PadType

Integer

是

1

垫片类型，取值及含义如下所示。

  • 1：图片；
  • 2：视频；
  • 3：源流最后一帧。
WaitDurationLong是1000断流等待时间，即直播断流后等待播放垫片的时长，单位为毫秒，取值范围为 [0,6000]。
MaxDurationLong是6000垫片最大播放时长，单位为毫秒，取值范围为 [1000,1000000000]。

Url

String

否

https://example.com/pad-material.mp4

垫片素材的地址，用于指定垫片播放时使用的图片或视频资源。

  • 当 PadType = 1（图片）或 PadType =2（视频）时有效；
  • 当 PadType = 3（源流最后一帧）无效。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=UpdateLivePadPreset&Version=2023-01-01
{
    "PresetName": "preset1",
    "PadType": 1,
    "WaitDuration": 3000,
    "MaxDuration": 3000,
    "Vhost": "vhost"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLivePadPreset",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
404ResourceNotFound.PresetNotExistpreset not found未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。