接口功能介绍
支持指定域名的直播转码、直播录制、直播截图和直播审核等媒体处理模板参数查询。
接口详情
请求方式：POST
请求路径：/live/media-template/query-media-template-detail
请求JSON参数
| 参数名 | 类型 | 名称 | 是否必填 | 说明 |
|---|---|---|---|---|
| domain | string | 域名 | 是 | 域名,一次只能提交1个域名 |
| app_name | string | 频道名 | 否 | 频道名 |
| stream_name | string | 流名 | 否 | 流名。如果请求参数中有stream_name，则app_name也必填。 |
| template_type | string | 模板类型 | 是 | 取值范围如下： live-tran: 直播转码 live-record: 直播录制 live-snapshot: 直播截图 live-identify：直播审核 |
| Page | int | 分页页码 | 否 | 取值范围≥1, 分页的页数,不传默认为1 |
| PageSize | int | 分页大小 | 否 | 每页模板数值，不传默认为100 |
响应JSON参数
| 参数名 | 类型 | 名称 |
|---|---|---|
| code | int | 状态码 |
| message | string | 描述信息 |
| TotalCount | int | 总记录数 |
| domain | string | 域名 |
| Result | list | 模板详情信息 |
Result
| 参数名 | 类型 | 名称 |
|---|---|---|
| TemplateID | string | 模板ID |
| app_name | string | 频道名 |
| stream_name | string | 流名 |
| TemplateName | string | 模板名 |
| TemplateType | string | 模板类型 |
| Description | string | 模板描述 |
| CreateTime | string | 创建时间 |
| UpdateTime | string | 修改时间 |
| Params | string | 模板参数 |
转码模板参数Params
| 参数名 | 类型 | 名称 |
|---|---|---|
| Output | list | 参数集 |
| Video | dict | 视频参数集 |
Output结构
| 参数名 | 类型 | 名称 |
|---|---|---|
| Format | dict | 参数格式 |
Format结构
| 参数名 | 类型 | 名称 |
|---|---|---|
| Vcodec | string | 视频编码 |
| OutputFormat | string | 推荐模板 |
| Vbr | string | 视频码率 |
| Width | string | 视频分辨率宽度 |
| Height | string | 视频分辨率高度 |
| Fr | string | 视频帧率 |
| Abr | string | 音频码率 |
| Asr | int | 音频采样率 |
| Acodec | string | 音频编码 |
| Gop | int | Gop |
| SeiType | int | SEI类型 取值范围：5、-1，默认-1（即不新增sei） |
| SeiPattern | string | SEI模式 |
| SeiContent | string | SEI内容 |
Video结构
| 参数名 | 类型 | 名称 |
|---|---|---|
| Logo | list | Logo |
Logo结构
| 参数名 | 类型 | 名称 |
|---|---|---|
| Pic | string | 水印图片地址 |
| OptimalW | int | 水印宽度 |
| OptimalH | int | 水印高度 |
| OffsetX | int | OffsetX |
| OffsetY | int | OffsetY |
录制模板参数Params
| 参数名 | 类型 | 名称 |
|---|---|---|
| Output | list | 参数集 |
| Output[].Format | string | 输出文件的封装格式 |
| Output[]. SegmentTime | string | 录制文件分段时长 1.当format为hls时，该字段代表ts文件的切片时长 2.当format为hls时，默认切片时长为10秒，为其它格式时默认分段为6小时 |
| Output[].OssFilePath | string | 文件存储路径 |
| Output[]. OssFileName | string | 文件命名规则 |
| OssRegion | string | OSS的Region名称 |
| OssBucket | string | OSS的Bucket名称 |
| OssEndpoint | string | OSS的服务地址 |
| OssExpiration | int | OSS的生命周期 |
截图模板参数Params
| 参数名 | 类型 | 名称 |
|---|---|---|
| Output | list | 参数集 |
| Output.Format | string | 图片格式 |
| Output.Interval | string | 截图间隔时长 |
| Output. SamplingSnapshot | int | 是否截关键帧 |
| Output.OssFilePath | string | 截图存储路径 |
| Output.OssFileName | string | 截图文件命名规则 |
| OssRegion | string | OSS存储的Region名称 |
| OssBucket | string | OSS存储的Bucket名称 |
| OssEndpoint | string | OSS存储的Endpoint名称 |
| OssExpiration | int | 存储时长 |
审核模板参数Params
| 参数名 | 类型 | 名称 |
|---|---|---|
| IdentifyType | int | 审核类型 |
| Output | object array | 直播审核参数 |
| Output.Format | string | 截图格式 |
| Output.Interval | string | 截图间隔 |
| OssBucket | string | OSS存储的Bucket名称 |
| OssRegion | string | OSS存储的Region名称 |
| OssEndpoint | string | OSS存储的Endpoint名称 |
示例
请求JSON示例
{
"domain": "ctyun.cn",
"app_name": "live10",
"stream_name": "live100",
"template_type": "live-record",
"page": 1,
"page_size": 100
}
正常响应JSON示例
{
"TotalCount": 1,
"code": 100000,
"domain": "ctyun.cn",
"message": "success",
"Result": [{
"app_name": "live10",
"Description": "test",
"stream_name": "live100",
"CreateTime": "2022-10-20 14:25:17",
"UpdateTime": "2022-10-24 16:41:01",
"TemplateName": "1665479006",
"Params": {
"OssExpiration": 2,
"OssEndpoint": "ctyun.cn1",
"Output": [{
"Format": "flv"
}],
"OssBucket": "testlive3",
"OssRegion": "test3"
},
"TemplateType": "live-record",
"TemplateID": "e398374uy8"
}]
}
