1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
该接口用来修改直播流监播任务的配置。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyLiveStreamMonitor。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
MonitorId | 是 | String | 监播任务ID。 示例值:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
MonitorName | 否 | String | 监播任务的名称。长度128字节以内(一个汉字两个字节)。 示例值:ExampleMonitorName |
OutputInfo | 否 | LiveStreamMonitorOutputInfo | 监播任务输出信息。 |
InputList.N | 否 | Array of LiveStreamMonitorInputInfo | 待监播的输入流信息。 |
NotifyPolicy | 否 | LiveStreamMonitorNotifyPolicy | 监播事件通知策略。 |
AsrLanguage | 否 | Integer | 智能语音识别语种: 0 关闭 1 中文 2 英文 3 日文 4 韩文。 示例值:0 |
OcrLanguage | 否 | Integer | 智能文字识别语种: 0 关闭 1 中、英文。 示例值:0 |
AiAsrInputIndexList.N | 否 | Array of Integer | 语音识别输入流列表,1代表第一条输入流。 示例值:[1, 2] |
AiOcrInputIndexList.N | 否 | Array of Integer | 文字识别输入流列表,1代表第一条输入流。 示例值:[1, 2] |
CheckStreamBroken | 否 | Integer | 是否开启断流检测。 示例值:0 |
CheckStreamLowFrameRate | 否 | Integer | 是否开启低帧率检测。 示例值:0 |
AllowMonitorReport | 否 | Integer | 是否存储监播事件到监播报告,以及是否允许查询监播报告。 示例值:0 |
AiFormatDiagnose | 否 | Integer | 是否开启格式诊断。 示例值:0 |
AiQualityControl | 否 | Integer | 是否开启内容质检。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改直播流监播任务
用户修改监播场次配置参数。
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLiveStreamMonitor
<公共请求参数>
{
"MonitorId": "abc",
"MonitorName": "abc",
"OutputInfo": {
"OutputStreamName": "abc",
"OutputStreamWidth": 1,
"OutputStreamHeight": 1,
"OutputDomain": "abc",
"OutputApp": "abc"
},
"InputList": [
{
"InputStreamName": "abc",
"InputDomain": "abc",
"InputApp": "abc",
"InputUrl": "abc",
"Description": "abc"
}
],
"NotifyPolicy": {
"NotifyPolicyType": 1,
"CallbackUrl": "abc"
},
"AsrLanguage": 1,
"OcrLanguage": 1,
"AiAsrInputIndexList": [
1
],
"AiOcrInputIndexList": [
1
],
"CheckStreamBroken": 1,
"CheckStreamLowFrameRate": 1,
"AllowMonitorReport": 1
}
输出示例
{
"Response": {
"RequestId": "ff29075a-ef7a-4742-9268-f7a1980dafc5"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.ConflictAction | 任务接口执行冲突。 |
FailedOperation.DatabaseNotAccessible | 数据库访问异常。 |
FailedOperation.InputStreamMixTypeNotAccessible | 禁止监播c流。 |
FailedOperation.MonitorIsActive | 监播任务处于启动状态。 |
FailedOperation.MonitorLimitExceeded | 监播任务超出限制。 |
FailedOperation.MonitorNotExist | 监播任务不存在。 |
FailedOperation.RelatedRunningMonitorLimitExceeded | 输入关联的运行中的监播任务超出限制。 |
FailedOperation.StartTaskFailed | 启动监播任务失败。 |
FailedOperation.StopTaskFailed | 停止监播任务失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.NotAllowUseLVB | 该APPID未开通LVB服务。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |