MediaThumbnails
GET
https://rtc-api.zego.im/
本接口用于对点播中的音视频媒体(比如 CDN 录制后文件)发起截图处理任务,包括“指定时间点截图”和“按时间间隔截图”。
- 指定时间点截图:文件开始播放后,将在所设置的时间点进行截图。
- 按时间间隔截图:文件开始播放后,将会根据所设置的时间间隔,反复进行截图,直至文件播放结束。
调用频率限制同一个 AppID 下所有房间:20 次/秒
Request
Query Parameters
- Tencent:腾讯云。
- Huawei:华为云。
- 腾讯云:FileID。
- 华为云:ObsObject。
- 录制文件生成回调 的参数 FileID 及 ObsObject。
- 媒体文件合并完成回调 的参数 file_id。
- 检索媒体信息 的参数 FileId。
- 指定时间点截图:SnapshotByTimeOffset。
- 按时间间隔截图:SampleSnapshot。
Action string必填
可选值: [MediaThumbnails
]
接口原型参数
https://rtc-api.zego.im?Action=MediaThumbnails
AppId uint32必填
💡公共参数。AppId,ZEGO 分配的用户唯一凭证。
SignatureNonce string必填
💡公共参数。随机字符串。
Timestamp int64必填
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
SignatureVersion string必填
可选值: [2.0
]
默认值: 2.0
💡公共参数。签名版本号。
Vendor string必填
可选值: [Tencent
, Huawei
]
对应的 CDN 厂商:
FileId string必填
文件唯一标识。各 CDN 厂商的录制文件唯一标识不同:
注意
ZEGO 不会对“传入的 FileId 文件是否真实存在”进行验证,请您注意填写正确的 FileId;传入错误的 FileId,响应参数中的 Code 为 1000。
Type string必填
可选值: [SnapshotByTimeOffset
, SampleSnapshot
]
截图方式。
Definition number
截图模板 ID,请联系 ZEGO 技术支持获取。
仅对 Vendor 取值为 Tencent 有效且为必填项,取值为 Huawei 无效。
ExtTimeOffsetSet number[]
需要截图的时间点,单位秒。
Type 取值为 SnapshotByTimeOffset 时必填。
Interval number
需要连续截图的时间间隔,单位秒。
仅对 Vendor 取值为 Huawei 有效且为必填项,取值为 Tencent 时无效。
Responses
- 200
成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSE清除