云直播修改导播台-直播导播台相关接口-API 中心-腾讯云

1. 接口描述

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

该接口用来设置导播台的描述、名称、录制模板id等参数。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyCaster。
Version	是	String	公共参数，本接口取值：2018-08-01。
Region	否	String	公共参数，本接口不需要传递此参数。
CasterId	是	Integer	导播台ID 示例值：63501
CasterName	否	String	导播台名称示例值：example
Description	否	String	导播台的描述最大允许长度256 示例值：example caster
RecordTemplateId	否	Integer	录制模板id。默认为0。当使用直播录制功能时，可将使用的录制模版填入。该接口仅保存字段，不涉及任何录制功能。示例值：1
RecordStatus	否	Integer	录制状态，当调用录制接口后，可通过该字段保存录制状态。 0：未录制 1：录制中该接口仅保存字段，不涉及任何录制处理。示例值：1
ExpireTime	否	Integer	导播台的过期时间戳。值为-1或unix时间戳。默认值为-1。当值为-1时，表示该导播台永不过期。当值为正常unix时间戳时，导播台将在该时间过期。导播台过期后，预监与主监画面将自动停止，转推自动停止。点播、直播url将停止转拉，推流url需自行停止推流。示例值：-1
DelayTime	否	Integer	导播台延时播放时间，单位为秒。默认为0，最大支持300秒示例值：0
TransitionType	否	String	导播台转场类型。默认为空。允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。示例值：heart
PgmWidth	否	Integer	导播台主监输出的宽度，单位为像素。默认为1280，最大允许4096。示例值：1280
PgmHeight	否	Integer	导播台主监输出的高度，单位为像素。默认为720，最大允许2160。示例值：720
PgmFps	否	Integer	导播台主监输出的帧率。默认为0，表示随源输出。最大支持60。示例值：0
PgmBitRate	否	Integer	导播台主监输出的码率，单位为kbps。默认为0，表示随源的码率输出。最大允许10000kbps。示例值：0
FeeType	否	Integer	导播台的计费类型。 0 通用型 1 播单型。注：本参数暂无作用。示例值：0
RecordTaskId	否	String	录制接口返回的taskid 注：该接口只做字段保存，不涉及录制操作。示例值：UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb
PgmAudioBitRate	否	Integer	导播台主监输出的音频码率，单位为kbps。可选项：[0, 128, 192, 256] 默认值为0，表示随源的音频码率输出。示例值：128

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

请求修改导播台信息

输入示例

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

{
    "RecordStatus": "1",
    "RecordTemplateId": "1",
    "CasterId": 63501,
    "CasterName": "Modify Caster"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.CasterNotFound	导播台不存在。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound.ForbidService	用户被禁用。
ResourceNotFound.FreezeService	用户服务被冻结。
ResourceNotFound.StopService	账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService	用户主动停服。
ResourceNotFound.UserNotExist	用户未注册直播。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

修改导播台

本页目录：