直播截图

使用前提

• 需要先联系商务开通云直播服务、CDN服务、KS3服务
• 主账号需要有可用的AKSK，用于存放录像文件的bucket设置为公开读写

开通方式

• 云直播控制台开通

概念解释

截图规则：以I帧为截图内容，抽取推流开始后第一个I帧作为第一张截图文件，可配置截图频率，即最小截图间隔时间。为您举例说明：截图频率20s，抽取第一个I帧为第一张截图，后续的第20s（含）后出现的第一个I帧为下一个截图文件，以此类推。

• 截图服务需要您在云直播控制台申请开通，目前原始截图文件支持jpg格式
• 支持截图的直播中心region：华北1（北京）、华北2（北京）、东南亚1（新加坡）

存储规则

关闭截图覆盖

说明：关闭截图覆盖后，您的截图文件名被置为{StreamName}-{UnixTimestamp}.jpg，在ks3中会保留全部的截图文件。

命名规则：{StreamName}-{UnixTimestamp}.jpg

存储路径：record/{App}/{StreamName}/picture/{UnixTimeMs}-{SessionId}/{StreamName}-{UnixTimestamp}.jpg

示例：record/myapp/mystream/picture/mystream-1587523655.jpg

目录说明

目录	描述
record	根目录
App	频道名
StreamName	流名
picture	存放截图文件的标识
UnixTimeMs	创建文件目录的毫秒时间戳
SessionId	随机数
UnixTimestamp	推流开始的毫秒时间戳

开启截图覆盖

说明：开启截图覆盖后，您的截图文件名会被置为{StreamName}.jpg，当新文件产生时会自动覆盖旧文件，因此最终您的ks3中只会保留最新的一个截图文件。

命名规则:{StreamName}.jpg

存储路径:record/{App}/{StreamName}/picture/{StreamName}.jpg

示例:record/myapp/mystream/picture/mystream.jpg

截图回调

配置回调url

在云直播控制台配置截图文件生成后的回调url即可，我们将截图文件信息以HTTP POST的形式通知给您。

回调示例

{
	"details": {
		"bucket": "yourbucket",
		"errnum": 0,
		"items": [{
			"dstpath": "record/app/streamname/picture/1683269715474_153042646/streamname-1683279837.jpg",
			"height": 1280,
			"output_format": 0,
			"size": "96733",
			"width": 720
		}],
		"region": "BEIJING",
		"srcHeight": 1280,
		"srcWidth": 720,
		"stream_name": "streamname",
		"timestamp": 1683279838,
		"uniqname": "youruniquename"
	},
        "status": 3,
	"taskid": "24dcb5bbd84f419e3dbfdc2cbad74742",
	"type": "LiveSnapShotCallBack",   
// 历史字段，忽略即可
	"itmes": [{
		"app": "yourapp",
		"cmd": "Nzk4MzcuanBn",
		"code": 3,
		"desc": "success",
		"domain": "yourpubdomain",
		"keys": ["record/app/streamname/picture/1683269715474_153042646/streamname-1683279837.jpg"]
	}]
	
}

参数说明

参数	类型	描述
taskid	string	任务ID
type	string	回调类型
details	json	回调主体，任务细节描述
errnum	int	任务状态执行码，0代表成功
errmsg	string	errmsg！=0时，描述错误细节信息
uniqname	string	域名空间
stream_name	string	截图来源的直播流名
timestamp	int	截图产生的时间点
srcWidth	int	用户设置的截图宽。截图失败时，不带此参数
srcHeight	int	用户设置的截图高。截图失败时，不带此参数
bucket	string	上传最终截图的bucket，如果有一转多，暂时只支持上传到同一个bucket
width	int	截图的宽
height	int	截图的高
intelligentSwitch	int	智能转码开关。1：不允许小转大。0：允许小转大。默认为0.如果不改变原图分辨率，该值无效
quality	int	输出截图质量，影响截图文件大小。取值1-10，超出无效，默认5
dstpath	string	截图指定bucket中上传路径(objectKey)
suffix	string	生成文件后缀名，模板参数
container	string	截图格式
status	int	已废弃，任务执行状态码以errnum为准