QC Request Template

Here is a complete template for making a QC request.

Auto

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</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": "[UserID]",
        "userkey": "[UserKey]",
        "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>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>AddMedia</action> // required
    <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 -->
        <qc>
            <!-- format validation tests -->
            <qc_test_name_1>
                <severity>[fatal|warning]</severity>
                <!-- tests params -->
            </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 multi-bitrate output formats -->
        <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 params -->
    </format>
</query>
{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "AddMedia", // required
        "qc_notify": "[QCNotifyURL]",
        "source": "[SourceFile|SourcePlaylist]", // required
        "format": {
            "output": "[advanced_hls|advanced_dash|advanced_fmp4|fmp4_hls|mp4|qc_check]", // required
            "qc": {
                "qc_test_name_1": {
                    "severity": "[fatal|warning]"
                    // test params
                },
                "qc_test_name_2": {
                    // test params
                },
                // multiple tests
                "qc_test_name_N": {
                    // test params
                }
            },
            "stream": {
                // stream params available only for advanced multi-bitrate output formats
                "qc": {
                    "qc_test_name_1": {
                        "severity": "[fatal|warning]"
                    },
                    "qc_test_name_2": {
                        // test params
                    },
                    // multiple tests
                    "qc_test_name_N": {
                        // test params
                    }
                }
            }
        }
    }
}

Common QC Test Parameters

ParameterDescriptionAllowed ValuesDefault Value
severitySpecify 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