全部产品
阿里云办公

更新截图配置

更新时间:2018-03-15 19:21:40

描述

更新直播流下的 AppName 截图配置,输出内容保存到 OSS 中,重新推流生效。

请求参数

参数 类型 是否必选 示例值 描述
Action String UpdateLiveAppSnapshotConfig

系统规定参数。取值:UpdateLiveAppSnapshotConfig

AppName String test123

直播流所属应用名称。
支持*号,代表该域名下所有的 AppName。

DomainName String test.com

加速域名。

OssBucket String test123

OSSBucket名称。

OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSSEndpoint域名。

OverwriteOssObject String {AppName}/{StreamName}.jpg

OSS 存储文件名,每次截图都覆盖此文件。

  • 小于 256bytes。
  • 目前仅支持生成 jpg 图片。
  • 支持变量匹配,包含 {AppName}、{StreamName},如:{AppName}/{StreamName}.jpg。
  • 传入-,表示删除此字段。

SequenceOssObject String snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

OSS 存储文件名,每次截图都递增存储,DescribeLiveStreamSnapshotInfo接口查询一段时间的文件。

  • 小于 256bytes。
  • 目前仅支持生成 jpg 图片。
  • 。支持变量匹配,包含 {AppName}、{StreamName}、{UnixTimestamp}、{Sequence},其中 {UnixTimestamp}、{Sequence} 必填一个,如:snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
  • 传入-,表示删除此字段。

TimeInterval Integer 5

截图周期。

  • 取值范围:[5,3600]
  • 单位:秒。

返回参数

参数 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID

示例

请求示例

  1. /?AppName=test123&DomainName=test.com
  2. &AccessKeyId=XxlctR6mMqO6mhXxX&Action=UpdateLiveAppSnapshotConfig
  3. &OssBucket=test123&OssEndpoint=oss-cn-shanghai.aliyuncs.com&OverwriteOssObject={AppName}/{StreamName}.jpg&SequenceOssObject=snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg&TimeInterval=5&<公共请求参数>

正常返回示例

JSON 格式

  1. {
  2. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
  3. }

异常返回示例

JSON 格式

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

错误码

查看本产品错误码