tencent cloud

媒体处理

动态与公告
产品动态
产品公告
产品简介
产品概述
产品功能
产品优势
应用场景
购买指南
计费说明
购买指引
续费说明
欠费说明
退费说明
快速入门
控制台指南
概览
创建任务
任务管理
编排管理
模板管理
资源包管理
视频评测
AIGC 内容生成
终端 SDK
字幕编辑工具
用量统计
访问管理示例
接入教程
音视频转码接入
音视频增强接入
音频分离接入
数字水印及明水印接入
媒体 AI 接入教程
媒体质检接入
终端 SDK 接入
直播流录制接入
DRM 接入
其他接入教程
场景实践教程
画质提升场景
音视频成本优化场景
短剧出海场景
生成式场景
在线教育场景
API 文档
History
Introduction
API Category
调用方式
发起处理任务相关接口
任务管理相关接口
转码增强模板相关接口
水印模板相关接口
截图模板相关接口
媒体AI模板相关接口
媒体AI-热词库相关接口
媒体AI-样本管理相关接口
媒体质检模板相关接口
直播录制模板相关接口
编排管理相关接口
数据统计相关接口
媒体传输-安全组管理相关接口
解析事件通知相关接口
图片处理模板相关接口
AI创作相关接口
其他接口
Data Types
Error Codes
其他说明文档
WebSocket 识别协议
常见问题
产品基础相关
账号授权相关
任务配置相关
发起任务相关
任务结果查看相关
相关协议
Service Level Agreement
隐私协议
数据处理和安全协议
联系我们
词汇表

ProcessLiveStream

PDF
聚焦模式
字号
最后更新时间: 2026-03-26 22:27:41

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.

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 stream URL (this must be a live stream address; supported formats include RTMP, HLS, FLV, TRTC, WebRTC, and SRT).
TRTC address example:
trtc://trtc.rtc.qq.com/mps/<roomid>?sdkappid=<sdkappid>&userid=<userid>&usersig=<usersig>
<roomid> is the TRTC room ID, which is a number.
<sdkappid> is the TRTC SDK app ID.
<userid> is the ID of the user who enters the room, which can be used to distinguish bots.
<usersig> is the TRTC user signature.

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

    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.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈