视频直播

产品文档

视频直播

帮助中心 > OpenAPI & SDK > 视频直播 > 查询直播截图模板列表

describeCustomLiveStreamSnapshotTemplates

描述

查询直播截图模板列表

请求方式

GET

请求地址

https://live.jdcloud-api.com/v1/snapshotCustoms

请求参数

名称 类型 是否必需 默认值 描述
pageNum Integer False 1 页码
- 取值范围 [1, 100000]
pageSize Integer False 10 分页大小
- 取值范围 [10, 100]
filters Filter[ ] False 截图模板查询过滤条件
- name: template 录制模板自定义名称
- value: 如果参数为空,则查询全部

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符,默认eq
values String[ ] True 过滤条件的值

返回参数

名称 类型 描述
result Result
requestId String requestId

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalCount Integer 查询总数
snapshotTemplates SnapshotTemplate[ ] 截图模板集合

SnapshotTemplate

名称 类型 描述
format String 截图格式
width Integer 截图宽度
- 单位: 像素
height Integer 截图高度
- 单位: 像素
fillType Integer 截图与设定的宽高不匹配时的处理规则
1: 拉伸
2: 留黑
3: 留白
4: 高斯模糊
snapshotInterval Integer 截图周期
- 单位: 秒
saveMode Integer 存储模式
1: 覆盖
2: 顺序编号存储
saveBucket String 存储桶
saveEndpoint String 存储地址
template String 截图模板自定义名称

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
404 Not found
500 Internal server error
503 Service unavailable

请求示例

GET

https://live.jdcloud-api.com/v1/snapshotCustoms?filters.1.name=template&filters.1.values.1=yoursnapshottemplate

返回示例

{
    "requestId": "bgvmivir54gddpgi764se9f4kfr7ge41", 
    "result": {
        "pageNumber": 1, 
        "pageSize": 10, 
        "snapshotTemplates": [
            {
                "fillType": 1, 
                "format": "jpg", 
                "height": 258, 
                "saveBucket": "yourbucket", 
                "saveEndpoint": "oss.xxx.com", 
                "saveMode": 1, 
                "snapshotInterval": 30, 
                "template": "yoursnapshottemplate", 
                "width": 126
            }
        ], 
        "totalCount": 1
    }
}
更新时间:2019-07-16 16:48:46
文档反馈 docs feedback