提交工单
咨询集成、功能及报价等问题
本接口用于对点播中的音视频媒体(比如 CDN 录制后文件)发起截图处理任务,包括“指定时间点截图”和“按时间间隔截图”。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Vendor |
String |
是 |
对应的 CDN 厂商:
|
FileId |
String |
是 |
文件唯一标识。 各 CDN 厂商的录制文件唯一标识不同:
ZEGO 不会对“传入的 FileId 文件是否真实存在”进行验证,请您注意填写正确的 FileId;传入错误的 FileId,响应参数中的 Code 为 1000。 |
Type |
String |
是 |
截图方式。
|
Definition |
Number |
否 |
截图模板 ID,请联系 ZEGO 技术支持获取。 仅对 Vendor 取值为 Tencent 有效且为必填项,取值为 Huawei 无效。 |
ExtTimeOffsetSet[] |
Array of Number |
否 |
需要截图的时间点,单位秒。 Type 取值为 SnapshotByTimeOffset 时必填。 |
Interval |
Number |
否 |
需要连续截图的时间间隔,单位秒。 仅对 Vendor 取值为 Huawei 有效且为必填项,取值为 Tencent 时无效。 |
https://rtc-api.zego.im/?Action=MediaThumbnails
&Vendor=Huawei
&FileId=/record/pickrecord/command_record/clarechen_test/2024-11-13-06-10-48.mp4
&Interval=2
&Type=SampleSnapshot
&<公共请求参数>
https://rtc-api.zego.im/?Action=MediaThumbnails
&Vendor=Tencent
&FileId=1397757897438985100
&Definition=10
&ExtTimeOffsetSet[]=1
&ExtTimeOffsetSet[]=2
&Type=SnapshotByTimeOffset
&<公共请求参数>
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 |
Message |
String |
操作结果描述。 |
RequestId |
String |
请求 ID,由 ZEGO 服务端返回。 |
Data |
Object |
响应数据。 |
Tencent |
Array of Object |
腾讯云返回内容(Vendor 为 Tencent 时返回)。 |
TaskId |
String |
全局唯一标识点播截图任务的任务 ID。 |
RequestId |
String |
唯一请求 ID。 如需 ZEGO 技术支持定位问题,需要提供该 RequestId。 |
Huawei |
Array of Object |
华为云返回内容(Vendor 为 Huawei 时返回)。 |
task_id |
String |
全局唯一标识点播截图任务的任务 ID。 |
{
"Code":0,
"Message":"success",
"Data":{
"Tencent":{
"TaskId":"1500030200-procedurev2-afc1fe7dfe51cd88a5d588cacba53393tt0",
"RequestId":"474284b3-d722-490a-ba2c-de0b472eab83"}
}
}
以下仅列出了常见的接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
0 | 请求成功。 | - |
2 | 输入参数错误。 | - |
3 | 未开通相关权限。 | 请联系 ZEGO 技术支持。 |
4 | CDN 类型不匹配。 | 请检查参数。 |
5 | 配置错误。 | 请联系 ZEGO 技术支持。 |
6 | 请求过于频繁。 | 请稍后重试。 |
7 | 鉴权失败。 | 请检查鉴权参数是否正确。 |
1000 | 请求失败。 | 请联系 ZEGO 技术支持。 |
41003 | 文件不存在。 | 请确认文件格式、文件 ID 等是否正确。 |
联系我们
文档反馈