有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

对直播流媒体发起处理任务,功能包括:

  • 智能内容审核(画面鉴黄、敏感信息检测、声音鉴黄);
  • 智能内容识别(人脸、文本全文、文本关键词、语音全文、语音关键词、语音实时翻译、物体识别、游戏打点)。
  • 智能内容分析(新闻实时拆条)。
  • 质检(直播流格式诊断、音画内容检测(抖动、模糊、低光照、过曝光、黑边、白边、黑屏、白屏、花屏、噪点、马赛克、二维码等)、无参考打分)。
  • 录制

直播流处理事件通知支持HTTP回调,也支持实时写入用户指定的消息队列 CMQ 中,用户从消息队列 CMQ 中获取事件通知结果,同时处理过程中存在输出文件的,会写入用户指定的输出文件的目标存储中。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ProcessLiveStream。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Url String 直播流 URL(必须是直播文件地址,支持 rtmp,hls 和 flv 等)。
示例值:http://www.abc.com/abc.m3u8
TaskNotifyConfig LiveStreamTaskNotifyConfig 任务的事件通知信息,用于指定直播流处理的结果。
OutputStorage TaskOutputStorage 直播流处理输出文件的目标存储。如处理有文件输出,该参数为必填项。
OutputDir String 直播流处理生成的文件输出的目标目录,如/movie/201909/,如果不填为 / 目录。
AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务参数。
AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务参数。
AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务参数。
AiQualityControlTask AiQualityControlTaskInput 视频内容质检类型任务参数。
SessionId String 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
SessionContext String 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
ScheduleId Integer 直播编排ID。
注意1:对于OutputStorage、OutputDir参数:
  • 当服务编排中子任务节点配置了OutputStorage、OutputDir时,该子任务节点中配置的输出作为子任务的输出。
  • 当服务编排中子任务节点没有配置OutputStorage、OutputDir时,若对直播流发起处理(ProcessLiveStream)有输出,将覆盖原有编排的默认输出。

  • 注意2:对于TaskNotifyConfig参数,若创建任务接口(ProcessLiveStream)有设置,将覆盖原有编排的默认回调。

    3. 输出参数

    参数名称 类型 描述
    TaskId String 任务 ID
    示例值:125xxxxxx07-live-procedure-813dc41e6fdc22dcf24aa6e9c61cp92
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 发起直播流识别任务

    对 URL 为 http://www.abc.com/abc.m3u8 的直播流发起内容识别任务。

    输入示例

    POST / HTTP/1.1
    Host: mps.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ProcessLiveStream
    <公共请求参数>
    
    {
        "Url": "http://www.abc.com/abc.m3u8",
        "AiRecognitionTask": {
            "Definition": "10"
        },
        "TaskNotifyConfig": {
            "CmqRegion": "gz",
            "CmqModel": "Queue",
            "QueueName": "queue-125717729292"
        }
    }

    输出示例

    {
        "Response": {
            "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
            "TaskId": "125xxxxxx07-live-procedure-813dc41e6fdc22dcf24aa6e9c61cp92"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.GenerateResource 生成资源失败。
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue.Definition 参数错误:Definition。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.SessionId 去重识别码重复,请求被去重。