logo
实时音视频
服务端 API
当前页

开始点播转码


描述

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

注意

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

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

接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=TranscodeMedia
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 完整公共参数列表请参考 调用方式 中的 “公共请求参数”。

参数类型是否必选描述
VendorString

CDN 厂商名。

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

FileIdString

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

注意

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

ResolutionString

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

  • 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。

请求示例

https://rtc-api.zego.im/?Action=TranscodeMedia
&Vendor=Tencent
&FileId=3270835011032053401
&Resolution=360p
&<公共请求参数>

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID,由 ZEGO 服务端返回。
DataObject响应数据。
└ TencentObject腾讯云 返回内容(Vendor 为 Tencent 时返回),详情可见Tencent
Tencent
参数类型描述
TaskIdString媒体文件转码任务的唯一标识 ID,转码结果可以通过 点播转码完成回调 查看。
RequestIdString唯一请求 ID,由请求参数 Vendor 取值对应的 CDN 厂商(即 Tencent)返回,定位问题时需要提供该次请求的 RequestId。

响应示例

{
    "Code": 0,
    "Message": "success",
    "Data": {
        "Tencent": {
            "TaskId": "1500020831-procedurev2-58ed61fcdbb0f78a0bf15cabd8ae4713tt0",
            "RequestId": "1413c592-5ad4-404e-bfa1-589c32dbcee8"
        }
    },
    "RequestId": "3574501647605445341"
}

返回码

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

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

Previous

查询媒体文件任务

Next

开始点播截图