1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
启动一路直播流审核。服务端异步拉流、定频截帧、音频切片、送审,通过回调返回结果。一次一个任务(一路流)。您可以通过此接口实现如下目标:
●指定内容参数(LiveModerationParams)来指定内容理解需要的详细参数。
●指定存储参数(LiveModerationStorageParams)将命中的切片文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)以及第三方AWS(S3)和阿里云(OSS)
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateLiveStreamModeration。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
| SdkAppId | 是 | Integer | TRTC的SdkAppId。 示例值:1400704311 |
| Input | 是 | Input | 直播流输入源 |
| LiveModerationParams | 是 | LiveModerationParams | 直播流ai理解审核参数 |
| DataId | 是 | String | 业务自定义唯一标识,原样透传到回调 入参限制:长度限制60字符 示例值:*rtmp-test |
| SourceInfo | 否 | SourceInfo | 额外信息透传结构体(房间/主播/业务自定义),原样回带到回调 |
| LiveModerationStorageParams | 否 | LiveModerationStorageParams | 直播流ai理解转存文件存储参数 |
| ResourceExpiredHour | 否 | Integer | 单路任务最大的生命周期 取值范围:[1, 72] 单位:小时 默认值:48 示例值:48 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | AI 内容理解服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数 示例值:WPqDNeW3D3UHPMW2q7FSYYz8VgxsBwiKFVq19GtbdXSkY4FJwWJsxU0UhrRTBEBupwKMn17ze1hYawpYtz9ANUVB5tPW0AkgEQxddua01cZuwpYVCb4H |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建直播流审核任务
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLiveStreamModeration
<公共请求参数>
{
"SdkAppId": 1400704311,
"Input": {
"Url": "rtmp://43.173.153.79/pull/9988123?sdkappid=1400704311&userid=inspect&usersig=eJwsjt8KgjAUh9-l3BZyphvaoBuDyvUX6gVMlxxqc*iQQfTukXr7ffD7fR*4H2*RDo46DZIJIWJEXI6Uam09PUl3IIFs73TlYVJ9-Sqdoxok44gp8oSx2VADEgRi65uNSk6rYA72XAxlfslVkVVbfX3vlX0oU7ZmEXbVep70ZP4FacaFiBnyiQ7jeRwhfH8BAAD--0M4MiU_&use_number_room_id=1&remoteuserid=inspect",
"Format": "rtmp"
},
"LiveModerationParams": {
"ModerationType": 3,
"MaxIdleTime": 30,
"SliceVideo": 5,
"SliceAudio": 1,
"SaveModerationFile": 1,
"CallbackAllResults": 0
},
"DataId": "*********rtmp-test",
"SourceInfo": {
"RoomId": "rtmp_test",
"RoomIdType": 1,
"UserId": "user0"
},
"LiveModerationStorageParams": {
"CloudModerationStorage": {
"Vendor": 0,
"Region": "ap-nanjing",
"Bucket": "ai-c*******tion-test-1254340397",
"AccessKey": "AKID*Q*******sHOEmtjIaaIjunSrypPijTw",
"SecretKey": "FPIuIPEle*******OQGo4LK1TeZDbojO",
"FileNamePrefix": [
"file_test"
]
}
},
"ResourceExpiredHour": 48
}
输出示例
{
"Response": {
"TaskId": "WPqDNeW3D3UHPMW2q7FSYYz8VgxsBwiKFVq19GtbdXSkY4FJwWJsxU0UhrRTBEBupwKMn17ze1hYawpYtz9ANUVB5tPW0AkgEQxddua01cZuwpYVCb4H",
"RequestId": "df91a81a-aeb9-4687-91fb-b356d448d453"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnRealNameAuthenticated | 未完成实名认证,不允许此操作。 |
| AuthFailure.UnauthorizedOperation | CAM鉴权失败。 |
| AuthFailure.UnsupportedOperation | 不支持该操作。 |
| FailedOperation | 操作失败。 |
| FailedOperation.RestrictedConcurrency | 单用户并发过载,请联系我们增大并发路数到合理值。 |
| InvalidParameter.OutOfRange | 参数超出范围。 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
| UnsupportedOperation | 操作不支持。 |