| 修改直播截图配置 | 您所在的位置：网站首页 › openlayers截图api › 修改直播截图配置 |
|
功能介绍
修改直播截图配置接口 调试您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URIPUT /v1/{project_id}/stream/snapshot 表1 路径参数参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 请求参数 表2 请求Header参数参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必填，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填，携带项目ID信息。 表3 请求Body参数参数 是否必选 参数类型 描述 domain 是 String 直播推流域名 app_name 是 String 应用名称 auth_key 否 String 回调鉴权密钥值 长度范围：[32-128] 若需要使用回调鉴权功能，请配置鉴权密钥，否则，留空即可。 time_interval 是 Integer 截图频率 取值范围：[5-3600] 单位：秒 object_write_mode 是 Integer 在OBS桶存储截图的方式： 0：实时截图，以时间戳命名截图文件，保存所有截图文件到OBS桶。例：snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg 1：覆盖截图，只保存最新的截图文件，新的截图会覆盖原来的截图文件。例：snapshot/{domain}/{app_name}/{stream_name}.jpg obs_location 是 ObsFileAddr object OBS存储位置信息 call_back_enable 否 String 是否启用回调通知 on：启用。 off：不启用。 call_back_url 否 String 通知服务器地址，必须是合法的URL且携带协议，协议支持http和https。截图完成后直播服务会向此地址推送截图状态信息。 表4 ObsFileAddr参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称 location 是 String OBS Bucket所在的区域，且必须保持与使用的直播服务区域保持一致。 object 是 String OBS对象路径，遵守OSS Object定义 当用于指示input时，需要指定到具体对象 当用于指示output时，只需指定到转码结果期望存放的路径 响应参数状态码： 400 表5 响应Body参数参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 PUT https://{endpoint}/v1/{project_id}/stream/snapshot { "domain" : "play.example.huawei.com", "app_name" : "live", "time_interval" : 5, "object_write_mode" : 1, "obs_location" : { "bucket" : "cls-test", "location" : "region1", "object" : "/ffff/aa/" } } 响应示例状态码： 400 修改直播截图配置操作失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } 状态码状态码 描述 200 修改直播截图配置操作成功 400 修改直播截图配置操作失败 错误码请参见错误码。 |
| CopyRight 2018-2019 实验室设备网 版权所有 |