Release NotesUser InterfaceSystem Status
Recent API Changes
Back to All

22 September 2022

about 2 years ago by Encoding.com Product Team #2

Qualify Validation QC Test

Added support of running Qualify Test Templates on your output media.

Available Tests

Test NameParameterSupported Formats
GENERAL VALIDATION TESTS
Qualify Validation<qc_qualify_validation />qc_check, mp4, cablelabs_mpegts, mainconcept_mxf

We provide running your own Qualify Template on your output media with our QC service.

🚧

Media Format

Qualify Validation available only for mp4, cablelabs_mpegts, and mainconcept_mxf output formats. For qc_check format, You can use any single-bitrate source file.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>AddMedia</action>
    <source>[SourceFile|SourcePlaylist]</source><!-- required -->
    <format>
        <output>[qc_check|mp4|cablelabs_mpegts|mainconcept_mxf]</output><!-- required -->
        <qc> 
            <qc_qualify_validation>
                <template>[TemplateName]</template><!-- required -->
            </qc_qualify_validation>
        </qc>
        <!-- format params -->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "AddMedia", // required
        "source": "[SourceFile|SourcePlaylist]", // required
        "format": {
            "output": "[qc_check|mp4|cablelabs_mpegts|mainconcept_mxf]", // required
            "qc": {
                "qc_qualify_validation": {
                    "template": "[TemplateName]" // required
                }
            }
            // format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
templateQualify Template name.Stringnone

Qualify Report

Link to Qualify Report can be found in GetStatus response 

<?xml version="1.0"?>
<report>
    <mediaID>[MediaID]</mediaID>
    <status>[QCStatus]</status>
    <externalReports>
        <externalReport>
            <testName>qc_qualify_validation</testName>
            <fileName>[FileName]</fileName>
            <ReportLinkJSON>[QualifyJSONReportURL]</ReportLinkJSON>
            <Result>[Success|Failure]</Result>
        </externalReport>
    </externalReports>
    <!-- report fields -->
</report>

{
    "report": {
        "mediaID": "[MediaID]",
        "status": "[QCStatus]",
        "externalReports": {
            "externalReport": [
                {
                    "testName": "qc_qualify_validation",
                    "fileName": "[FileName]",
                    "ReportLinkJSON": "[QualifyJSONReportURL]",
                    "Result": "[Success|Failure]"
                }
            ]
        }
        // report fields
    }
}

Qualify Templates Management

Create Template

Request:
<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>SetQualifyTemplate</action> <!-- required-->
    <template><![CDATA[
{
    "id": "[TemplateID]",
    "created_at": "[TemplateCreatedDate]",
    "updated_at": "[TemplateUpdatedDate]",
    "name": "[TemplateName]",
    "tests": {
        [TestsList]
    }
}
]]></template> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "SetQualifyTemplate", // required
        "template": {
            "id": "[TemplateID]",
            "created_at": "[TemplateCreatedDate]",
            "updated_at": "[TemplateUpdatedDate]",
            "name": "[TemplateName]",
            "tests": {
                [TestsList]
            }
        } // required
    }
}
ParameterDescriptionAllowed ValuesDefault Value
templateQualify templateJSON string for XML request and JSON object for JSON request.
For XML request it should be wrapped in <![CDATA[]]> tage.		none
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>setqualifytemplate</action>
    <status>Success</status>
</response>

{
    "response": {
        "action": "setqualifytemplate",
        "status": "Success"
    }
}

Update Template

Request:
<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>UpdateQualifyTemplate</action> <!-- required-->
    <template><![CDATA[
{
    "id": "[TemplateID]",
    "created_at": "[TemplateCreatedDate]",
    "updated_at": "[TemplateUpdatedDate]",
    "name": "[TemplateName]",
    "tests": {
        [TestsList]
    }
}
]]></template> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "UpdateQualifyTemplate", // required
        "template": {
            "id": "[TemplateID]",
            "created_at": "[TemplateCreatedDate]",
            "updated_at": "[TemplateUpdatedDate]",
            "name": "[TemplateName]",
            "tests": {
                [TestsList]
            }
        } // required
    }
}
ParameterDescriptionAllowed ValuesDefault Value
templateQualify templateJSON string for XML request and JSON object for JSON request.
For XML request it should be wrapped in <![CDATA[]]> tage.		none
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>updatequalifytemplate</action>
    <status>Success</status>
</response>

{
    "response": {
        "action": "updatequalifytemplate",
        "status": "Success"
    }
}

Remove Template

Request:
<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>RemoveQualifyTemplate</action> <!-- required-->
    <template_name>[TemplateName]</template_name> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "RemoveQualifyTemplate", // required
        "template_name": "[TemplateName]" // required
    }
}
ParameterDescriptionAllowed ValuesDefault Value
template_nameTemplate NameStringnone
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>removequalifytemplate</action>
    <status>Success</status>
</response>

{
    "response": {
        "action": "removequalifytemplate",
        "status": "Success"
    }
}