ProcessLiveStream

Last updated: 2021-01-21 17:54:13

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

This API is used to initiate tasks to process live streaming media files. Such tasks include:

  • Intelligent content moderation (detecting porn, terrorism, and politically sensitive information in image and porn information in speech)
  • Intelligent content recognition (face, full text, text keyword, full speech, and speech keyword)

Live stream processing event notifications are written into specified CMQ queues in real time. Users need to obtain event notification results from such CMQ queues. Output files of the processing tasks are written into destination buckets specified by users.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 parameter. The value used for this API: ProcessLiveStream.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. This parameter is not required for this API.
Url Yes String Live stream URL, which must be a live stream file address. RTMP, HLS, and FLV are supported.
TaskNotifyConfig Yes LiveStreamTaskNotifyConfig Event notification information of a task, which is used to specify the live stream processing result.
OutputStorage No TaskOutputStorage Target bucket of a live stream processing output file. This parameter is required if a file will be output.
OutputDir No String Target directory of a live stream processing output file, such as /movie/201909/. If this parameter is left empty, the / directory will be used.
AiContentReviewTask No AiContentReviewTaskInput Type parameter of a video content audit task.
AiRecognitionTask No AiRecognitionTaskInput Type parameter of video content recognition task.
SessionId No String The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
SessionContext No String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Initiating a live steam audit task

This example shows you how to initiate a content recognition task for a live stream whose URL is http://www.abc.com/abc.m3u8.

Input Example

https://mps.tencentcloudapi.com/?Action=ProcessLiveStream
&Url=http://www.abc.com/abc.m3u8
&TaskNotifyConfig.CmqModel=Queue
&TaskNotifyConfig.CmqRegion=gz
&TaskNotifyConfig.QueueName=queue-125717729292
&AiRecognitionTask.Definition=10
&<Public request parameter>

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.

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.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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help