tencent cloud

文档反馈

CreateQualityControlTemplate

最后更新时间:2024-11-07 11:24:01

1. API Description

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

This API is used to create a media quality inspection template. Up to 50 templates can be created.

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 Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateQualityControlTemplate.
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.
Name Yes String Media quality inspection template name, with a length limit of 64 characters.
QualityControlItemSet.N Yes Array of QualityControlItemConfig Media quality inspection control parameters.
Comment No String Media quality inspection template description, with a length limit of 256 characters.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique identifier of a media quality inspection template.
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 Creating a Media Quality Inspection Template

Input Example

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateQualityControlTemplate
<Common request parameters>



{
    "Name": "example",
    "Comment": "",
    "QualityControlItemSet": [
        {
            "Type": "LowEvaluation",
            "Switch": "ON"
        },
        {
            "Type": "Mosaic",
            "Switch": "OFF"
        },
        {
            "Type": "CrashScreen",
            "Switch": "OFF"
        },
        {
            "Type": "Blur",
            "Switch": "OFF"
        },
        {
            "Type": "BlackWhiteEdge",
            "Switch": "OFF"
        },
        {
            "Type": "LowLighting",
            "Switch": "OFF"
        },
        {
            "Type": "HighLighting",
            "Switch": "OFF"
        },
        {
            "Type": "NoVoice",
            "Switch": "OFF"
        },
        {
            "Type": "LowVoice",
            "Switch": "OFF"
        },
        {
            "Type": "HighVoice",
            "Switch": "OFF"
        },
        {
            "Type": "VideoResolutionChanged",
            "Switch": "OFF"
        },
        {
            "Type": "AudioSampleRateChanged",
            "Switch": "OFF"
        },
        {
            "Type": "AudioChannelsChanged",
            "Switch": "OFF"
        },
        {
            "Type": "ParameterSetsChanged",
            "Switch": "OFF"
        },
        {
            "Type": "DarOrSarInvalid",
            "Switch": "OFF"
        },
        {
            "Type": "TimestampFallback",
            "Switch": "OFF"
        },
        {
            "Type": "DtsJitter",
            "Switch": "OFF"
        },
        {
            "Type": "PtsJitter",
            "Switch": "OFF"
        },
        {
            "Type": "AACDurationDeviation",
            "Switch": "OFF"
        },
        {
            "Type": "AudioDroppingFrames",
            "Switch": "OFF"
        },
        {
            "Type": "VideoDroppingFrames",
            "Switch": "OFF"
        },
        {
            "Type": "AVTimestampInterleave",
            "Switch": "OFF"
        },
        {
            "Type": "PtsLessThanDts",
            "Switch": "OFF"
        },
        {
            "Type": "ReceiveFpsJitter",
            "Switch": "OFF"
        },
        {
            "Type": "ReceiveFpsTooSmall",
            "Switch": "OFF"
        },
        {
            "Type": "FpsJitter",
            "Switch": "OFF"
        },
        {
            "Type": "StreamOpenFailed",
            "Switch": "OFF"
        },
        {
            "Type": "StreamEnd",
            "Switch": "OFF"
        },
        {
            "Type": "StreamParseFailed",
            "Switch": "OFF"
        },
        {
            "Type": "VideoFirstFrameNotIdr",
            "Switch": "OFF"
        },
        {
            "Type": "StreamNALUError",
            "Switch": "OFF"
        },
        {
            "Type": "TsStreamNoAud",
            "Switch": "OFF"
        },
        {
            "Type": "AudioStreamLack",
            "Switch": "OFF"
        },
        {
            "Type": "VideoStreamLack",
            "Switch": "OFF"
        },
        {
            "Type": "LackAudioRecover",
            "Switch": "OFF"
        },
        {
            "Type": "LackVideoRecover",
            "Switch": "OFF"
        },
        {
            "Type": "VideoBitrateOutofRange",
            "Switch": "OFF"
        },
        {
            "Type": "AudioBitrateOutofRange",
            "Switch": "OFF"
        },
        {
            "Type": "VideoDecodeFailed",
            "Switch": "OFF"
        },
        {
            "Type": "AudioDecodeFailed",
            "Switch": "OFF"
        },
        {
            "Type": "AudioOutOfPhase",
            "Switch": "OFF"
        },
        {
            "Type": "VideoDuplicatedFrame",
            "Switch": "OFF"
        },
        {
            "Type": "AudioDuplicatedFrame",
            "Switch": "OFF"
        },
        {
            "Type": "VideoRotation",
            "Switch": "OFF"
        },
        {
            "Type": "TsMultiPrograms",
            "Switch": "OFF"
        },
        {
            "Type": "Mp4InvalidCodecFourcc",
            "Switch": "OFF"
        },
        {
            "Type": "HLSBadM3u8Format",
            "Switch": "OFF"
        },
        {
            "Type": "HLSInvalidMasterM3u8",
            "Switch": "OFF"
        },
        {
            "Type": "HLSInvalidMediaM3u8",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMasterM3u8Recommended",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMediaM3u8Recommended",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMediaM3u8DiscontinuityExist",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMediaSegmentsStreamNumChange",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMediaSegmentsPTSJitterDeviation",
            "Switch": "OFF"
        },
        {
            "Type": "HLSMediaSegmentsDTSJitterDeviation",
            "Switch": "OFF"
        },
        {
            "Type": "TimecodeTrackExist",
            "Switch": "OFF"
        }
    ]
}

Output Example

{
    "Response": {
        "Definition": 200090,
        "RequestId": "7bb44c6c-92d0-4dad-99cf-88f569c6d3ad"
    }
}

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
InvalidParameter Parameter error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.AACDurationDeviation Parameter configuration error: improper AAC frame timestamp interval.
InvalidParameterValue.AVTimestampInterleave Parameter configuration error: improper audio-video interleaving.
InvalidParameterValue.AudioBitrateOutofRange Parameter configuration error: audio stream bitrate out of range.
InvalidParameterValue.AudioChannelsChanged Parameter configuration error: audio track change.
InvalidParameterValue.AudioDecodeFailed Parameter configuration error: audio decoding error.
InvalidParameterValue.AudioDroppingFrames Parameter configuration error: audio frame dropping.
InvalidParameterValue.AudioDuplicatedFrame Parameter configuration error: duplicate frames in audio streams.
InvalidParameterValue.AudioOutOfPhase Parameter configuration error: opposite phase in dual-channel audio.
InvalidParameterValue.AudioSampleRateChanged Parameter configuration error: audio sample rate change.
InvalidParameterValue.AudioStreamLack Parameter configuration error: no audio stream.
InvalidParameterValue.BlackWhiteEdge Parameter configuration error: black and white edges detection.
InvalidParameterValue.Blur Parameter configuration error: blur detection.
InvalidParameterValue.Comment Parameter error: template description.
InvalidParameterValue.CrashScreen Parameter configuration error: screen glitch detection.
InvalidParameterValue.DarOrSarInvalid Parameter configuration error: video aspect ratio exception.
InvalidParameterValue.DtsJitter Parameter configuration error: DTS jitter too high.
InvalidParameterValue.EmptyDetectItem Enabled detection items in template configuration are empty.
InvalidParameterValue.FpsJitter Parameter configuration error: significant jitter in the stream frame rate calculated via PTS.
InvalidParameterValue.HLSBadM3u8Format Parameter configuration error: invalid M3U8 file.
InvalidParameterValue.HLSInvalidMasterM3u8 Parameter configuration error: invalid main M3U8 file.
InvalidParameterValue.HLSInvalidMediaM3u8 Parameter configuration error: invalid media M3U8 file.
InvalidParameterValue.HLSMasterM3u8Recommended Parameter configuration error: parameters recommended by standards missing in main M3U8.
InvalidParameterValue.HLSMediaM3u8DiscontinuityExist Parameter configuration error: EXT-X-DISCONTINUITY in media M3U8.
InvalidParameterValue.HLSMediaM3u8Recommended Parameter configuration error: parameters recommended by standards missing in media M3U8.
InvalidParameterValue.HLSMediaSegmentsDTSJitterDeviation Parameter configuration error: DTS jumps between segments without EXT-X-DISCONTINUITY.
InvalidParameterValue.HLSMediaSegmentsPTSJitterDeviation Parameter configuration error: PTS jumps between segments without EXT-X-DISCONTINUITY.
InvalidParameterValue.HLSMediaSegmentsStreamNumChange Parameter configuration error: changed number of streams in segments.
InvalidParameterValue.HighLighting Parameter configuration error: brightness anomaly of overexposure.
InvalidParameterValue.HighVoice Parameter configuration error: high voice detection.
InvalidParameterValue.LackAudioRecover Parameter configuration error: missing audio stream recovery.
InvalidParameterValue.LackVideoRecover Parameter configuration error: missing video stream recovery.
InvalidParameterValue.LowEvaluation Parameter configuration error: no-reference scoring.
InvalidParameterValue.LowLighting Parameter configuration error: brightness anomaly of low light.
InvalidParameterValue.LowVoice Parameter configuration error: low voice detection.
InvalidParameterValue.Mosaic Parameter configuration error: mosaic detection.
InvalidParameterValue.Mp4InvalidCodecFourcc Parameter configuration error: codec FourCC in MP4 not meeting Apple HLS requirements.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.NoVoice Parameter configuration error: no voice detection.
InvalidParameterValue.ParameterSetsChanged Parameter configuration error: stream parameter set information change.
InvalidParameterValue.PtsJitter Parameter configuration error: PTS jitter too high.
InvalidParameterValue.PtsLessThanDts Parameter configuration error: PTS less than DTS for media streams.
InvalidParameterValue.ReceiveFpsJitter Parameter configuration error: significant jitter in the network receive frame rate.
InvalidParameterValue.ReceiveFpsTooSmall Parameter configuration error: network receive video frame rate too low.
InvalidParameterValue.StreamEnd Parameter configuration error: stream end.
InvalidParameterValue.StreamNALUError Parameter configuration error: NALU start code error.
InvalidParameterValue.StreamOpenFailed Parameter configuration error: stream open failure.
InvalidParameterValue.StreamParseFailed Parameter configuration error: stream parsing failure.
InvalidParameterValue.SvgTemplate Incorrect parameter value: SVG is empty.
InvalidParameterValue.TimecodeTrackExist Parameter configuration error: TMCD track in MP4.
InvalidParameterValue.TimestampFallback Parameter configuration error: DTS timestamp rollback.
InvalidParameterValue.TsMultiPrograms Parameter configuration error: multiple programs in MPEG2-TS streams.
InvalidParameterValue.TsStreamNoAud Parameter configuration error: no AUD NALU in the H26x stream of MPEG-TS.
InvalidParameterValue.UnknownCategory Unknown diagnostic category.
InvalidParameterValue.VideoBitrateOutofRange Parameter configuration error: video stream bitrate out of range.
InvalidParameterValue.VideoDecodeFailed Parameter configuration error: video decoding error.
InvalidParameterValue.VideoDroppingFrames Parameter configuration error: video frame dropping.
InvalidParameterValue.VideoDuplicatedFrame Parameter configuration error: duplicate frames in video streams.
InvalidParameterValue.VideoFirstFrameNotIdr Parameter configuration error: first frame not an IDR frame.
InvalidParameterValue.VideoFreezedFrame Parameter configuration error: video freezing.
InvalidParameterValue.VideoResolutionChanged Parameter configuration error: video resolution change.
InvalidParameterValue.VideoRotation Parameter configuration error: video rotation.
InvalidParameterValue.VideoStreamLack Parameter configuration error: no video stream.
LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.