logo
实时音视频
服务端 API
场景服务接口
当前页

MediaThumbnails

GET

https://rtc-api.zego.im/

本接口用于对点播中的音视频媒体(比如 CDN 录制后文件)发起截图处理任务,包括“指定时间点截图”和“按时间间隔截图”。

  • 指定时间点截图:文件开始播放后,将在所设置的时间点进行截图。
  • 按时间间隔截图:文件开始播放后,将会根据所设置的时间间隔,反复进行截图,直至文件播放结束。
    调用频率限制
    同一个 AppID 下所有房间:20 次/秒

Request

Query Parameters

    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 厂商:

    • Tencent:腾讯云。
    • Huawei:华为云。

    FileId string必填

    文件唯一标识。各 CDN 厂商的录制文件唯一标识不同:

    • 腾讯云:FileID。
    • 华为云:ObsObject。
    您可以通过以下方式获取:

    注意

    ZEGO 不会对“传入的 FileId 文件是否真实存在”进行验证,请您注意填写正确的 FileId;传入错误的 FileId,响应参数中的 Code 为 1000。

    Type string必填

    可选值: [SnapshotByTimeOffset, SampleSnapshot]

    截图方式。

    • 指定时间点截图:SnapshotByTimeOffset。
    • 按时间间隔截图:SampleSnapshot。
    Definition number

    截图模板 ID,请联系 ZEGO 技术支持获取。
    仅对 Vendor 取值为 Tencent 有效且为必填项,取值为 Huawei 无效。

    ExtTimeOffsetSet number[]

    需要截图的时间点,单位秒。
    Type 取值为 SnapshotByTimeOffset 时必填。

    Interval number

    需要连续截图的时间间隔,单位秒。
    仅对 Vendor 取值为 Huawei 有效且为必填项,取值为 Tencent 时无效。

Responses

成功
Schema
    Code int32

    返回码。 以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码

    返回码说明处理建议
    0请求成功。-
    2输入参数错误。-
    3未开通相关权限。请联系 ZEGO 技术支持。
    4CDN 类型不匹配。请检查参数。
    5配置错误。请联系 ZEGO 技术支持。
    6请求过于频繁。请稍后重试。
    7鉴权失败。请检查鉴权参数是否正确。
    1000请求失败。请联系 ZEGO 技术支持。
    41003文件不存在。请确认文件格式、文件 ID 等是否正确。
    Message string

    操作结果描述

    RequestId string

    请求 ID,由 ZEGO 服务端返回

    Data object
    响应数据
    Tencent object
    腾讯云返回内容(Vendor 为 Tencent 时返回)
    TaskId string

    全局唯一标识点播截图任务的任务 ID

    RequestId string

    唯一请求 ID。如需 ZEGO 技术支持定位问题,需要提供该 RequestId

    Huawei object
    华为云返回内容(Vendor 为 Huawei 时返回)
    task_id string

    全局唯一标识点播截图任务的任务 ID


Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query
query
query
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

开始点播转码

Next

开始音频流审核

当前页

返回到顶部