直播封面 - 直播

开发者中心

直播

服务端 API

直播封面

更新时间： 2021/09/07 03:40:23

该功能为增值功能。如需使用，请联系客户经理开通“直播动态封面”功能及“点播”服务。

设置动态封面配置

用于设置某个cid的直播动态封面配置。该接口不建议频繁调用，因为配置只在下次推流时才会生效。

以下三种情况会把当前sequence重置为0。

更新了overlap。
overlap为2，更新了maxCount比原来的maxCount要小。
更新了format。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/config/setup HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	cid。
gapTime	int	必选	间隔时间，秒。
duration	int	必选	时长。
format	string	必选	mp4，flv ，gif，webp。
overlap	int	必选	覆盖方式，1或者2。
maxCount	int	可选	视频保留数。当覆盖方式为2时，必填。
width	int	可选	输出视频的宽，最大640，单独设置一个，另外一个按照原来宽高比等比例缩放。
height	int	可选	输出视频的高，最大640，单独设置一个，另外一个按照原来宽高比等比例缩放。
fps	int	可选	帧率，最大20。
videoBitRate	int	可选	视频码率，最大1024，单位K,动图无效。
an	int	可选	1-去除音频，0-保留音频，动图无效。

overlap与maxCount说明：

overlap可取值1或2。

1表示单张覆盖，这种情况下maxCount没有意义，因为每次上传到nos都用的同一个key。key为live_video_snapshot_{cid}.{format}。
2表示多张覆盖，maxCount这种情况，上传的key会在0到maxCount-1之间.key为live_video_snapshot_{cid}-{sequence}.{format}。如果最大张数是10，第一个视频的序列号是0，等序列号到9的时候，就会循环回来把0这个序列号的视频覆盖掉。

返回参数

参数	类型	说明
code	Int	状态码。
requestId	String	请求id。
msg	String	错误信息, 非200状态码下返回。

示例

curl请求示例

	curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid":"f400be4c182f4317aca984639cdcb2dd","gapTime":15,"duration":5,"format":"mp4","overlap":2,"maxCount":20，"an":1}' https://vcloud.163.com/app/channel/snapshot/video/config/setup

返回示例

    //成功结果示例。
    "Content-Type": "application/json; charset=utf-8"
    {        
        "code":200,
        "requestId": "xxx"
    }
    
    //错误返回示例。
    "Content-Type": "application/json; charset=utf-8"
    {
        "code":723,
        "msg":"使用直播截图功能需开通云点播服务",
        "requestId": "xxx"
    }

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
723	使用直播预览功能需要开通云点播服务。
1694	请先停止正在运行的直播动态封面任务。
1697	直播动态封面功能未开通。
501	内部错误。

获取动态封面配置

获取频道下的直播动态封面配置。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/config/get HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	频道ID。

返回参数

参数	类型	说明
code	int	状态码。
requestId	String	请求id。
ret	JSON	返回信息, 200状态码下返回。
msg	String	错误信息, 非200状态码下返回。

其中，ret格式如下：

参数	类型	说明
cid	string	频道ID。
gapTime	int	间隔时间，秒。
duration	int	时长。
format	string	mp4,flv,gif,webp。
overlap	int	覆盖方式，1-单张覆盖，2-多张覆盖。
maxCount	int	视频保留数。
width	int	输出视频的宽。
height	int	输出视频的高。
fps	int	帧率。
videoBitRate	int	视频码率，单位kbps。
an	int	1-去除音频，0-保留音频。

示例

curl请求示例

    curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid": "cidxxxxxxxxx"}' https://vcloud.163.com/app/channel/snapshot/video/config/get

返回示例

{
    "ret": {
        "cid": "f400be4c182f4317aca984639cdcb2dd",
        "gapTime": 15,
        "duration": 5,
        "format": "mp4",
        "overlap": 1,
        "maxCount": 20,
        "width": 640,
        "height": 360,
        "fps": 20,
        "an":1
        "videoBitRate": 1024
    },
    "code": 200,
    "requestId": "live968521809d0b4623a877ad24f78399d4"
}

// 如果从未配置的cid则返回null。
{
    "ret": null,
    "code": 200,
    "requestId": "livef365fddb40fa4e75806634b85e91306f"
}

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
723	使用直播动态封面功能需要开通云点播服务。
1697	直播动态封面功能未开通。
501	内部错误。

删除直播动态封面配置

删除频道下的直播动态封面配置。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/config/delete HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	频道ID。

返回参数

参数	类型	说明
code	int	状态码。
requestId	String	请求id。
msg	String	错误信息, 非200状态码下返回。

示例

curl请求示例

    curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid": "cidxxxxxxxxx"}' https://vcloud.163.com/app/channel/snapshot/video/config/delete

返回示例

    //成功结果示例。
    "Content-Type": "application/json; charset=utf-8"
    {        
        "code":200,
        "requestId": "xxx"
    }
    
    //错误返回示例。
    "Content-Type": "application/json; charset=utf-8"
    {
        "code":1694,
        "msg":"请先停止正在运行的直播动态封面任务",
        "requestId": "xxx"
    }

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
1694	请先停止正在运行的直播动态封面任务。
723	使用直播动态封面功能需要开通云点播服务。
1697	直播动态封面功能未开通。
501	内部错误。

获取当前动态封面视频序列

获取当前动态封面视频序列sequence。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/sequence HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	频道ID。

返回参数

参数	类型	说明
code	int	状态码。
requestId	String	请求id。
ret	JSON	返回信息, 200状态码下返回。
msg	String	错误信息, 非200状态码下返回。

其中，ret格式如下：

参数	类型	说明
cid	string	频道ID。
currentSequenceNum	int	当前序列号。
currentObjectName	string	当前对象名。
currentSnapPlayerUrl	string	当前动态封面视频的播放地址。
currentSnapDownloadUrl	string	当前动态封面视频的下载地址。
currentStartTime	int	当前动态封面视频的开始时间，单位秒。

示例

curl请求示例

    curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid": "cidxxxxxxxxx"}' https://vcloud.163.com/app/channel/snapshot/video/sequence

返回示例

{
    "ret": {
        "currentSequenceNum": 0,
        "currentStartTime": 1571131995,
        "currentObjectName": "live_video_snapshot_f400be4c182f4317aca984639cdcb2dd-0.mp4",
        "currentSnapPlayerUrl": "http://vodldsadbvz.vod.126.net/live_video_snapshot_f400be4c182f4317aca984639cdcb2dd-0.mp4",
        "cid": "f400be4c182f4317aca984639cdcb2dd",
        "currentSnapDownloadUrl": "http://vodldsadbvz.nosdn.127.net/live_video_snapshot_f400be4c182f4317aca984639cdcb2dd-0.mp4"
    },
    "code": 200,
    "requestId": "liveeea082e72b16445f9b13d45fe8689ed8"
}

{
    "msg": "视频动态封面配置不存在",
    "code": 1693,
    "requestId": "live081870270eed4d8882195af06c61a72f"
}


// 如果计算出来的object不存在。
{
    "code": 1695,
    "msg":"动态封面视频对象不存在",
    "requestId": "live2e3dcabee9a74af98a8b9daea14b9308"
}

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
1693	视频动态封面配置不存在。
723	使用直播动态封面功能需要开通云点播服务。
1697	直播动态封面功能未开通。
501	内部错误。

开始直播动态封面预览

开始直播动态封面预览，预览参数采用上面配置的参数。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/start HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	频道ID。
version	long	必选	版本号。

返回参数

参数	类型	说明
code	int	状态码。
requestId	String	请求id。
msg	String	错误信息, 非200状态码下返回。

示例

curl请求示例

    curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid": "cidxxxxxxxxx","version":123}' https://vcloud.163.com/app/channel/snapshot/video/start

返回示例

    //成功结果示例。
    "Content-Type": "application/json; charset=utf-8"
    {        
        "code":200,
        "requestId": "xxx"
    }
    
    //错误返回示例。
    "Content-Type": "application/json; charset=utf-8"
    {
        "code":1694,
        "msg":"请先停止正在运行的直播动态封面预览任务",
        "requestId": "xxx"
    }

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
723	使用直播动态封面功能需要开通云点播服务。
1693	视频动态封面配置不存在。
1690	直播动态封面任务已存在。
1697	直播动态封面功能未开通。
501	内部错误。

停止直播动态封面预览

停止正在进行用的直播动态封面预览，version必须与开始直播动态封面预览中的version一致，否则停止失败。

URL

POST https://vcloud.163.com/app/channel/snapshot/video/stop HTTP/1.1
Content-Type: application/json;charset=utf-8

请求参数

参数	类型	是否必选	描述
cid	string	必选	频道ID。
version	long	必选	版本号。

返回参数

参数	类型	说明
code	int	状态码。
requestId	String	请求id。
msg	String	错误信息, 非200状态码下返回。

示例

curl请求示例

    curl -X POST -H "Content-Type: application/json" -H "AppKey: 29781bbc4db54742a3ebcxxxxxxxxxxx" -H "Nonce: 12345" -H "CurTime: 1469171950571" -H "CheckSum: 4ba6ca70c685eb900917e423eadaxxxxxxxxxxxxx" -d '{"cid": "cidxxxxxxxxx","version":123}' https://vcloud.163.com/app/channel/snapshot/video/sequence

返回示例

    //成功结果示例。
    "Content-Type": "application/json; charset=utf-8"
    {        
        "code":200,
        "requestId": "xxx"
    }
    
    //错误返回示例。
    "Content-Type": "application/json; charset=utf-8"
    {
        "code":1694,
        "msg":"请先停止正在运行的直播动态封面预览任务",
        "requestId": "xxx"
    }

响应状态码

code	说明
200	操作成功。
409	用户登录认证失败。
607	用户信息不存在。
631	参数非法。
617	频道信息与当前用户不匹配。
1691	直播动态封面预览任务不存在。
1692	版本不符合。
501	内部错误。

此文档是否对你有帮助？

有帮助

去反馈

设置动态封面配置
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码
获取动态封面配置
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码
删除直播动态封面配置
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码
获取当前动态封面视频序列
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码
开始直播动态封面预览
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码
停止直播动态封面预览
URL
请求参数
返回参数
示例
curl请求示例
返回示例
响应状态码