Overview
Menu

ParseLiveStreamProcessNotification

Last updated: 2024-09-30 14:49:13Download PDF

1. API Description

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

This API is used to parse the content of an MPS live stream processing event notification from the msgBody field in the message received from CMQ.
Instead of initiating a video processing task, this API is used to help generate SDKs for various programming languages. You can parse the event notification based on the analytic function of the SDKs.

A maximum of 20 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ParseLiveStreamProcessNotification.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
ContentYesStringLive stream event notification obtained from CMQ.

3. Output Parameters

Parameter NameTypeDescription
NotificationTypeStringLive stream processing result type, including:
  • AiReviewResult: content moderation result;
  • AiRecognitionResult: content recognition result;
  • LiveRecordResult: live recording result;
  • ProcessEof: live stream processing result.
  • TaskIdStringVideo processing task ID.
    ProcessEofInfoLiveStreamProcessErrorInfoInformation of a live stream processing error, which is valid when NotificationType is ProcessEof.
    Note: This field may return null, indicating that no valid values can be obtained.
    AiReviewResultInfoLiveStreamAiReviewResultInfoContent audit result, which is valid when NotificationType is AiReviewResult.
    Note: This field may return null, indicating that no valid values can be obtained.
    AiRecognitionResultInfoLiveStreamAiRecognitionResultInfoContent recognition result, which is valid if NotificationType is AiRecognitionResult.
    AiAnalysisResultInfoLiveStreamAiAnalysisResultInfo
    AiQualityControlResultInfoLiveStreamAiQualityControlResultInfo
    LiveRecordResultInfoLiveStreamRecordResultInfoLive recording result is valid when NotificationType is LiveRecordResult.
    Note: This field may return null, indicating that no valid values can be obtained.
    SessionIdStringThe 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.
    SessionContextStringThe 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.
    RequestIdStringThe 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 Parsing a live stream event notification

    Input Example

    https://mps.tencentcloudapi.com/?Action=ParseLiveStreamProcessNotification
    &Content={"NotificationType":"AiReviewResult",XXX
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "NotificationType": "AiReviewResult",
            "TaskId": "2459149217-procedure-live-xxx51da009t0",
            "ProcessEofInfo": null,
            "AiReviewResultInfo": {
                "ResultSet": [
                    {
                        "Type": "VoicePorn",
                        "ImagePornResultSet": [],
                        "ImageTerrorismResultSet": [],
                        "ImagePoliticalResultSet": [],
                        "VoicePornResultSet": [
                            {
                                "StartPtsTime": 0.266,
                                "EndPtsTime": 4.146,
                                "Confidence": 98,
                                "Suggestion": "block",
                                "Label": "sexual_moan"
                            }
                        ]
                    }
                ]
            },
            "SessionId": "",
            "SessionContext": "",
            "RequestId": "335bdaa3-db0e-46ce-9946-51941d9cb0f5"
        }
    }
    

    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 CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InvalidParameterValue.InvalidContentThe value of the parsed Content is invalid.