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

TranscodeMedia

GET

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

用户进行 CDN 录制时,可以将录制好的媒体文件存放在 CDN 服务器上,并通过本接口对媒体文件进行点播转码,改变源文件的编码格式、分辨率和码率等属性,在不同终端、网络环境中进行播放。

注意

首次使用本接口之前,请确认是否已经开通 CDN 录制服务。若未开通,请前往 ZEGO 控制台 自助开通,详情请参考 控制台 - 服务配置 - CDN,或联系 ZEGO 技术支持开通,并配置回调地址,媒体文件转码完成后会通过 点播转码完成回调 通知。

开发者可以通过 点播转码完成回调查询媒体文件任务 接口,查看转码任务的状态、文件回放地址等详细信息。

调用频率限制
同一个 AppID 下所有房间:20 次/秒

Request

Query Parameters

    Action stringrequired

    Possible values: [TranscodeMedia]

    接口原型参数

    https://rtc-api.zego.im?Action=TranscodeMedia

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    Vendor stringrequired

    Possible values: [Tencent]

    CDN 厂商名。

    当前仅支持取值为 Tencent:腾讯云。

    FileId stringrequired

    需要转码的源文件 ID,可以通过以下方式获取:

    注意

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

    Resolution stringrequired

    Possible values: [360p, 540p, 720p]

    转码后的媒体文件分辨率,有以下取值可选:

    • 360p
    • 540p
    • 720p

    注意

    如果您需要自定义文件转码参数,请联系 ZEGO 技术支持配置自定义模板。对于常见的转码规格,默认的各分辨率转码模板对应的参数如下:

    • 360p:封装格式 MP4,视频编码 H.264,码率 400 kbps,帧率25 fps,音频编码 AAC。
    • 540p:封装格式 MP4,视频编码 H.264,码率 1000 kbps,帧率 25 fps,音频编码 AAC。
    • 720p:封装格式 MP4,视频编码 H.264,码率 1800 kbps,帧率 25 fps,音频编码 AAC。

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,由请求参数 Vendor 取值对应的 CDN 厂商(即 Tencent)返回,定位问题时需要提供该次请求的 RequestId。


Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

查询媒体文件任务

Next

开始点播截图

当前页

返回到顶部