文档中心>API 中心>云直播>直播导播台相关接口>复制导播台预监展示信息创建主监任务

复制导播台预监展示信息创建主监任务

最近更新时间:2024-12-26 01:44:47

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

该接口用来将预监画面的布局、水印、字幕等配置,复制到主监画面中。
该接口使用时,预监任务需处于运行状态。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCasterPgmFromPvw。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
CasterId Integer 导播台ID。
示例值:63501

3. 输出参数

参数名称 类型 描述
PgmPlayUrl String 主监任务的rtmp协议预览地址。
注:该地址仅供预览,不可分发。
示例值:rtmp://www.example.com/live/example_stream_id
CdnPlayUrl String 注:该字段已废弃,请结合腾讯云直播播放地址生成策略生成cdn播放地址
示例值:https://example.cdn.com/live/example_stream_id
CdnStreamId String 主监任务在腾讯云直播侧的流ID。
示例值:example_stream_id
PgmWebRTCPlayUrl String 主监任务的webrtc协议播放地址。
注:
1.该预览地址仅作为预览,不可分发。
2.webrtc播放地址需配合腾讯云快直播播放sdk使用。
示例值:webrtc://webrtc.domain.com/live/example_stream
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 复制预监的布局配置到主监任务中

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCasterPgmFromPvw
<公共请求参数>

{
    "CasterId": 63501
}

输出示例

{
    "Response": {
        "PgmPlayUrl": "rtmp://www.example.com/live/example_stream_id",
        "PgmWebRTCPlayUrl": "webrtc://webrtc.example.com/live/example_stream_id",
        "CdnPlayUrl": "https://cdn.example.com/live/example_stream_id",
        "CdnStreamId": "example_stream_id",
        "RequestId": "84fea7c5-37e7-4d89-ba04-76338dc7b41d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CasterExpired 导播台处于过期状态。
FailedOperation.CasterNotFound 导播台不存在。
FailedOperation.CreateCasterTaskFailed 创建/更新导播台主监、预监任务失败,可能是并发操作了同一个主监或预监任务。
FailedOperation.NoLVBPushOrPlayDomain 直播未配置推流或播放域名
FailedOperation.ResourceNotEnough 启动时后台资源不足。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
ResourceNotFound.UserNotExist 用户未注册直播。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。