QC Request Template

Here is a complete template for making a QC request.

Auto

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>AddMedia</action>
    <qc_notify>[QCNotifyURL]</qc_notify>
    <source>[SourceFile|SourcePlaylist]</source><!-- REQUIRED -->
    <format>
        <output>[advanced_hls|advanced_dash|advanced_fmp4|fmp4_hls|mp4]</output><!-- REQUIRED -->
        <!-- Format fields -->
        <qc>auto</qc>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "AddMedia",
        "qc_notify": "[QCNotifyURL]",
        "source": "[SourceFile|SourcePlaylist]",
        "format": {
            "output": "[advanced_hls|advanced_dash|advanced_fmp4|fmp4_hls|mp4]",
            "qc": "auto"
        }
    }
}

Custom Tests

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>AddMedia</action>
    <qc_notify>[QCNotifyURL]</qc_notify>
    <source>[SourceFile|SourcePlaylist]</source><!-- REQUIRED -->
    <format>
        <output>[advanced_hls|advanced_dash|advanced_fmp4|fmp4_hls|mp4|qc_check]</output><!-- REQUIRED -->
        <!-- Format fields -->
        <qc>
            <!-- Format Validation Tests -->
            <qc_test_name_1>
                <!-- Tests Params -->
                <severity>[fatal|warning]</severity>
            </qc_test_name_1>
            <qc_test_name_2>
                <!-- Tests Params -->
            </qc_test_name_2>
            <!-- Multiple Tests -->
            <qc_test_name_N>
                <!-- Tests Params -->
            </qc_test_name_N>
        </qc>
        <!-- <stream /> params available only for advanced_hls output format -->
        <stream>
            <qc>
                <!-- Stream Validation Tests -->
                <qc_test_name_1>
                    <!-- Tests Params -->
                    <severity>[fatal|warning]</severity>
                </qc_test_name_1>
                <qc_test_name_2>
                    <!-- Tests Params -->
                <severity>[fatal|warning]</severity>
                </qc_test_name_2>
                <!-- Multiple Tests -->
                <qc_test_name_N>
                    <!-- Tests Params -->
                <severity>[fatal|warning]</severity>
                </qc_test_name_N>
            </qc>
        </stream>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "AddMedia",
        "qc_notify": "[QCNotifyURL]",
        "source": "[SourceFile|SourcePlaylist]",
        "format": {
            "output": "[advanced_hls|advanced_dash|advanced_fmp4|fmp4_hls|mp4|qc_check]",
            "qc": {
                "qc_test_name_1": {
                    "severity": "[fatal|warning]"
                },
                "qc_test_name_2": "",
                "qc_test_name_N": ""
            },
            "stream": {
                "qc": {
                    "qc_test_name_1": {
                        "severity": "[fatal|warning]"
                    },
                    "qc_test_name_2": {
                        "severity": "[fatal|warning]"
                    },
                    "qc_test_name_N": {
                        "severity": "[fatal|warning]"
                    }
                }
            }
        }
    }
}

Common QC Test Parameters

Parameter

Description

Allowed Values

Default Value

severity

Specify the test level severity.

warning – Tests with ‘warning’ severity generate messages in report but qc process will continue.
fatal – Tests with ‘fatal’ severity will stop QC process.

warning