tencent cloud

APIs

DocumentaçãoAPIsMedia Processing ServiceProcessing Task Initiation APIsProcessLiveStream

ProcessLiveStream

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-13 17:12:17

1. API Description

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

Initiate processing task for live streaming. Features include:

  • Intelligent content moderation (porn detection in images, sensitive information detection, and audio pornography detection);
  • Smart content recognition (human faces, full texts, text keywords, full speech, speech keywords, real-time speech translation, object recognition, and game tagging).
    Intelligent content analysis (highlight splitting and compilation).
    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 real-time writing to a user-specified TDMQ CMQ. Users obtain event notification results from TDMQ CMQ. If output files exist during the process, they are written to the target storage of the user-specified output files.

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 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 streaming URL (must be a live streaming address, supporting rtmp, hls, flv, trtc, webrtc, srt, etc.).
The trtc address is as follows:
trtc://trtc.rtc.qq.com/mps/<roomid>?sdkappid=<sdkappid>&userid=<userid>&usersig=<usersig>
<roomid> is the room number ID of trtc
<sdkappid> is the SDK app ID of trtc
<userid> is the user ID for the service to enter a room, which can be used to identify the robot
<usersig> is the signature of the trtc user

webrtc supports LEB live streams. For address retrieval, please refer

For supported srt addresses, please refer
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 /movie/201909/. If this is not specified, the default directory is /.
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.
Note 1: For the OutputStorage and OutputDir parameters:

  • If OutputStorage and OutputDir are configured in the subtask node of service orchestration, the output configured in the subtask node serves as the subtask output.
  • If OutputStorage and OutputDir are not configured in the subtask node of service orchestration and ProcessLiveStream has output, the default output of the original orchestration is overridden.
    • Note 2: For the TaskNotifyConfig parameter, if it has been configured in the task creation API (ProcessLiveStream), the default callback of the original orchestration is overridden.
    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 Trigger a live stream identification task

    This example shows you how to initiate a content recognition task for a 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.

    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: illegal mps user.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameterValue.Definition Parameter error: Definition.
    InvalidParameterValue.Definitions Parameter error: Definitions.
    InvalidParameterValue.SessionId Duplicate recognition code. Request deduplicated.
    Anterior: ProcessMediaPróximo: ProcessImage

    Ajuda e Suporte

    Esta página foi útil?

    comentários

    Search
      Enter keywords to search documentation