1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to initiate a processing task for live streaming. Features include:.
Intelligent content moderation (porn detection in images, sensitive information detection, audio pornography detection);.
- Smart content recognition (human faces, full texts, text keywords, full speech, speech keywords, real-time speech translation, object recognition, game tagging).
Intelligent content analysis (clipping, highlights).
Quality inspection (live stream format diagnosis, audio and video content detection (jitter, blur, low light, overexposure, black and white edges, black and white screens, screen glitch, noise, mosaic, QR code, and more), and no-reference scoring).
recording.
Live stream processing event notification supports HTTP callback and also supports real-time writing to user-specified TDMQ CMQ. Users obtain event notification results from TDMQ CMQ. Meanwhile, if output files exist during the process, they will be written to the target storage specified by the user.
A maximum of 100 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ProcessLiveStream. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Url | Yes | String | Live stream URL (this must be a live stream address; supported formats include RTMP, HLS, FLV, TRTC, WebRTC, and SRT). WebRTC supports LEB live streams. For more information about how to obtain the address, see this reference. For supported SRT addresses, see this reference. |
| TaskNotifyConfig | Yes | LiveStreamTaskNotifyConfig | Event notification information of the task. This is used to specify the live stream processing result. |
| OutputStorage | No | TaskOutputStorage | Target storage for the output file of the live stream processing task. This parameter is required if the processing task has an output file. |
| OutputDir | No | String | Target output directory for the file generated by the live stream processing task, such as |
| AiContentReviewTask | No | AiContentReviewTaskInput | Parameters for the video content review task. |
| AiRecognitionTask | No | AiRecognitionTaskInput | Parameters for the video content recognition task. |
| AiAnalysisTask | No | AiAnalysisTaskInput | Parameters for the video content analysis task. |
| AiQualityControlTask | No | AiQualityControlTaskInput | Parameters for the media quality inspection task. |
| SmartSubtitlesTask | No | LiveSmartSubtitlesTaskInput | Parameters for the smart subtitle task. |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed. |
| SessionContext | No | String | Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters. |
| ScheduleId | No | Integer | Live streaming orchestration ID. |
| ResourceId | No | String | Resource ID. The resource needs to be enabled. The default value is the account's primary resource ID. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Initiating a Live Stream Identification Task
Trigger a content recognition task for the live stream with the URL http://www.abc.com/abc.m3u8.
Input Example
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessLiveStream
<Common request parameters>
{
"Url": "http://www.abc.com/abc.m3u8",
"AiRecognitionTask": {
"Definition": 10
},
"TaskNotifyConfig": {
"CmqRegion": "gz",
"CmqModel": "Queue",
"QueueName": "queue-125717729292"
}
}
Output Example
{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-live-procedure-813dc41e6fdc22dcf24aa6e9c61cp92"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.GenerateResource | Resource generation failed. |
| FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Definition | Parameter error: Definition. |
| InvalidParameterValue.Definitions | Parameter error: Definitions. |
| InvalidParameterValue.SessionId | The deduplication ID already exists. The request is removed due to duplication. |
Feedback