1. 接口描述
接口请求域名: cme.tencentcloudapi.com 。
本接口废弃,可创建媒体转推项目替代,操作媒体转推项目可使用 HandleMediaCastProject 接口 实现。
操作类型
AddInput
(添加输入源),包括:DeleteInput
(删除输入源),参见 示例5;ModifyInput
(修改输入源),参见 示例6;AddOutput
( 添加输出源),参见 示例7;DeleteOutput
(删除输出源),参见 示例8;ModifyOutput
(修改输出源),参见 示例9;Start
(开启转推),参见 示例10;Stop
(停止转推),参见 示例11;SwitchInput
(切换输入源),参见 示例12;ModifyCurrentStopTime
(修改当前计划结束时间),参见 示例13;DescribeInputPlayInfo
(查询播放进度),参见 示例14。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:HandleStreamConnectProject。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Platform | 是 | String | 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台。 示例值:1000000009 |
ProjectId | 是 | String | 云转推项目 Id 。 示例值:67e105de4fb8950001052fff |
Operation | 是 | String | 请参考 操作类型 示例值:AddInput |
InputInfo | 否 | StreamInputInfo | 转推输入源操作参数。具体操作方式详见 操作类型 及下文示例。 |
InputEndpoint | 否 | String | 主备输入源标识,取值有: 示例值:Main |
OutputInfo | 否 | StreamConnectOutput | 转推输出源操作参数。具体操作方式详见 操作类型 及下文示例。 |
CurrentStopTime | 否 | String | 云转推当前预计结束时间,采用 ISO 日期格式。具体操作方式详见 操作类型 及下文示例。 示例值:2021-03-23T07:51:18.029Z |
Operator | 否 | String | 操作者。如不填,默认为 cmeid_system ,表示平台管理员操作,可以操作所有云转推项目。如果指定操作者,则操作者必须为项目所有者。示例值:60097a8a8ea83d00017b484b |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
StreamInputRtmpPushUrl | String | 输入源推流地址,当 Operation 取值 AddInput 且 InputType 为 RtmpPush 类型时有效。 示例值:rtmp://livepush.video-studio.myqcloud.com/output/1250000001-6086 |
VodPullInputPlayInfo | VodPullInputPlayInfo | 点播输入源播放进度信息,当 Operation 取值 DescribeInputPlayInfo 且 InputType 为 VodPull 类型时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改输入源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 ModifyInput |
InputEndpoint | 是 | String | Main 或 Backup |
InputInfo | 是 | StreamInputInfo | 输入源 |
输入示例
输出示例
示例2 修改输出源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 ModifyOutput |
OutputInfo | 是 | StreamConnectOutput | 输出源,Id 字段必填,从获取项目列表中拿到对应输出源的 Id |
输入示例
输出示例
示例3 停止云转推
停止云转推包括停止输入源、输出源转推。
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 Stop |
输入示例
输出示例
示例4 切换输入源
云转推主备输入源切换,当前转推输入源为Main,切换到Backup输入源。
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 SwitchInput |
InputEndPoint | 是 | String | Main 或 Backup |
输入示例
输出示例
示例5 删除输入源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 DeleteInput |
InputEndpoint | 是 | String | Main 或 Backup |
输入示例
输出示例
示例6 删除输出源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 DeleteOutput |
OutputInfo | 是 | StreamConnectOutput | 输出源,Id 字段必填,从获取项目列表接口中拿到对应输出源的 Id |
输入示例
输出示例
示例7 开启云转推
开启云转推包括开启输入源、输出源转推。
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 Start |
输入示例
输出示例
示例8 添加输出源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 AddOutput |
OutputInfo | 是 | StreamConnectOutput | 输出源,Id 字段若不填则由后端生成 |
输入示例
输出示例
示例9 修改转推结束时间
修改当前正在转推项目的转推预计结束时间。
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 ModifyCurrentStopTime |
CurrentStopTime | 是 | String | 当前转推预计结束时间,ISO 日期格式,不得超过当前时间30天 |
输入示例
输出示例
示例10 添加直播拉流输入源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 AddInput |
InputEndpoint | 是 | String | Main 或 Backup |
InputInfo | 是 | StreamInputInfo | 输入源,InputType 取值 LivePull |
输入示例
输出示例
示例11 添加直播推流输入源
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 AddInput |
InputEndpoint | 是 | String | Main 或 Backup |
InputInfo | 是 | StreamInputInfo | 输入源,InputType 取值 RtmpPush , 从获取项目列表接口可拿到对应推流输入源的 PushUrl |
输入示例
输出示例
示例12 查询点播输入源播放进度
查询当前正在转推项目的点播输入源播放进度。
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 DescribeInputPlayInfo |
InputEndpoint | 是 | String | Main 或 Backup |
输入示例
输出示例
示例13 添加点播拉流输入源且单次播放
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 AddInput |
InputEndpoint | 是 | String | Main 或 Backup |
InputInfo | 是 | StreamInputInfo | 输入源,InputType 取值 VodPull , VodPullInputInfo.LoopTimes 取值 0 |
输入示例
输出示例
示例14 添加点播拉流输入源且循环播放
输入参数:
除公共参数及 Platform、ProjectId 之外,其余参数填写规范如下:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Operation | 是 | String | 请填写 AddInput |
InputEndpoint | 是 | String | Main 或 Backup |
InputInfo | 是 | StreamInputInfo | 输入源,InputType 取值 VodPull , VodPullInputInfo.LoopTimes 取值-1 |
输入示例
输出示例
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.StreamConnect | 转推操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Platform | 平台参数非法。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Category | 项目类别不合法。 |
InvalidParameterValue.ExtInfoInvalid | 拓展信息不合法。 |
InvalidParameterValue.Input | 转推输入流参数非法。 |
InvalidParameterValue.Platform | 平台参数取值错误。 |
InvalidParameterValue.ProjectId | 项目不存在。 |
InvalidParameterValue.StreamConnect | 云转推信息非法。 |
InvalidParameterValue.StreamConnectInputInvalid | 转推输入源信息非法。 |
InvalidParameterValue.StreamConnectOutputInvalid | 转推输出源信息非法。 |
InvalidParameterValue.StreamInput | 输入流参数错误。 |
LimitExceeded.BillItemLiveDispatchDuration | 您已超过推流时长限制,若还需使用,请升级会员版本或购买资源包。 |
LimitExceeded.BillItemLiveDispatchMaxCount | 您已达到转推并发数上限,若还需使用,请升级会员版本或购买资源包。 |
OperationDenied.PermissionDeny | 权限不足,请检查对应操作者的权限。 |
ResourceNotFound.Platform | 平台不存在。 |