AddLiveAppSnapshotConfig
配置截图信息。输出内容保存到OSS中，重新推流即生效
服务地址：
华东2（上海）
输入参数
只看必填
DomainName主播流域名
AppName播流所属应用名称
TimeInterval截图周期
OssEndpointOSS存储的Endpoint名称
OssBucketOSS存储的Bucket名称
OverwriteOssObject覆盖截图存储文件名
SequenceOssObject实时截图存储文件名
Callback截图回调地址
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

  • 请确保在使用该接口前，已充分了解直播截图的收费方式和价格。计费详情，请参见直播截图费用。

  • 视频直播截图功能需要将截图文件存放在 Bucket 中，因此需要开通 OSS 服务并且拥有至少一个 Bucket 用于存储这些截图文件。具体操作请参见配置 OSS。

  • 直播截图存储在 OSS 中，会产生存储费用，在 OSS 中计费详情请参见存储费用。

  • OSS Bucket 必须与播流域名的直播中心同地域，不支持跨地域截图。

QPS 限制

本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

请求参数

字段名称字段详情
DomainNamestring

主播流域名。

示例值:example.com参考取值来源:
    AddLiveDomain
    DescribeDomainUsageData
    ListLiveRealtimeLogDeliveryDomains
AppNamestring

播流所属应用名称。展开详情

示例值:liveApp****参考取值来源:
    GetMessageApp
    ListMessageApp
    QueryMessageApp
    CreateMessageApp
TimeIntervalinteger<int32>

截图周期，每个间隔周期截一次图片。单位：秒。取值范围：5~3600。

示例值:5取值 <= 3600
OssEndpointstring

OSS 存储的 Endpoint 名称。展开详情

示例值:cn-oss-****.aliyuncs.com
OssBucketstring

OSS 存储的 Bucket 名称。展开详情

示例值:liveBucket****
OverwriteOssObjectstring

覆盖截图存储文件名。每次截图都覆盖此文件。展开详情

示例值:{AppName}/{StreamName}.jpg
SequenceOssObjectstring

实时截图存储文件名。展开详情

示例值:snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
Callbackstring

截图回调地址。

示例值:https://learn.aliyundoc.com参考取值来源:
    QuerySnapshotCallbackAuth
    ModifyLiveMessageAppCallback

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
变更历史
暂无变更历史