云直播查询导播台展示信息

1. 接口描述

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

查询导播台PVW任务和PGM任务的展示信息，包括使用的布局、水印、字幕等信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
Status	Integer	导播台状态 0：停止状态，无预监，无主监 1：无预监，有主监 2：有预监，无主监 3：有预监，有主监示例值：1
PvwDisplayInfo	CasterDisplayInfo	预监使用的展示参数。
PgmDisplayInfo	CasterDisplayInfo	主监使用的展示参数。
StartLiveTime	Integer	启动直播的时间，值为unix时间戳。示例值：1670309219
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询导播台展示信息

输入示例

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

{
    "CasterId": 63501
}

输出示例

{
    "Response": {
        "PvwDisplayInfo": {
            "LayoutIndex": 0,
            "MarkPicIndexList": [],
            "MarkWordIndexList": [],
            "TransitionType": "",
            "AudioIndexList": []
        },
        "PgmDisplayInfo": {
            "LayoutIndex": 0,
            "MarkPicIndexList": [],
            "MarkWordIndexList": [],
            "TransitionType": "",
            "AudioIndexList": []
        },
        "Status": 0,
        "RequestId": "uuid",
        "StartLiveTime": 1670309219
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound.CasterNotExists	导播台不存在。
ResourceNotFound.UserNotExist	用户未注册直播。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

查询导播台展示信息

本页目录：