06 April 2023
over 1 year ago by Encoding.com Product Team #2
Required destination for Reference Movie Alias
The parameter set as mandatory if <reference_movie_alias /> set to non-default value.
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>[Action]</action>
<source>[SourceFile]</source> <!-- required-->
<format> <!-- required -->
<output>[output]</output> <!-- required -->
<destination>[DestinationPath]</destination> <!-- required for multi-bitrate formats
and if reference_movie_alias set to non-default value
and pack_files set to no -->
<profile>[ProfileName]</profile>
<encoder>[EncoderVersion]</encoder>
<two_pass>[yes|no]</two_pass>
<two_pass_decoding>[1|]</two_pass_decoding>
<bufsize>[BufferSize]</bufsize>
<rc_init_occupancy>[BufferOccupancy]</rc_init_occupancy>
<deinterlacing>[yes|filter|no|auto]</deinterlacing>
<force_interlaced>[InterlacedType]</force_interlaced>
<add_meta>[yes|no]</add_meta>
<hint>[yes|no]</hint>
<preset>[WebMPreset]</preset>
<bframes>[BFramesMode]</bframes>
<!-- bframes option only available for mpeg2 output -->
<gop>[GOPType]</gop>
<luma_spatial>[SpatialLumaStrength]</luma_spatial>
<chroma_spatial>[SpatialChromaStrength]</chroma_spatial>
<luma_temp>[TemporalLumaStrength]</luma_temp>
<strip_chapters>[yes|no]</strip_chapters>
<vidly_hls>[yes|no]</vidly_hls>
<vidly_hd>[yes|no]</vidly_hd>
<hard_cbr>[yes|no]</hard_cbr>
<pix_format>[PixFormat]</pix_format>
<best_quality>[yes|no]</best_quality>
<interlaced>[yes|no]</interlaced>
<copy_timestamps>[yes|no]</copy_timestamps>
<slices>[SlicesNumber]</slices>
<speed>[SpeedCorrection]</speed>
<scale_in_color_matrix>[ColorMatrix]</scale_in_color_matrix>
<scale_out_color_matrix>[ColorMatrix]</scale_out_color_matrix>
<alpha_channel>[yes|no]</alpha_channel>
<black_padding_start>[FramesPadding]</black_padding_start>
<black_padding_end>[FramesPadding]</black_padding_end>
<black_padding_keyframe>[yes|no]</black_padding_keyframe>
<stream_id_mapping>[IDMapping]</stream_id_mapping>
<transport_stream_id>[TsID]</transport_stream_id>
<intermediate_stitch_multijob>[yes|no]</intermediate_stitch_multijob>
<reference_movie_alias>[0|2|3]</reference_movie_alias>
<pack_files>[yes|no]</pack_files>
<telecine>
<first_field>[top|bottom]</first_field>
<pattern>[PulldownPattern]</pattern>
</telecine>
<atadenoise>
<a0>[AThresholdPane1]</a0>
<b0>[BThresholdPane1]</b0>
<a1>[AThresholdPane2]</a1>
<b1>[BThresholdPane2]</b1>
<a2>[AThresholdPane3]</a2>
<b2>[BThresholdPane3]</b2>
<s>[AveragingFramesNumber]</s>
<p>[AveragingPlanes]</p>
</atadenoise>
<!-- format params -->
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "addMedia", // required
"source": "[SourceFile]", // required
"format": {
"output": "mov", // required
"destination": "[DestinationPath]", // required for multi-bitrate formats
// and if reference_movie_alias set to non-default value
// and pack_files set to no
"reference_movie_alias": "[0|2|3]",
"pack_files": "no",
// format params
}
}
}
| Parameter | Description | Allowed Values | Default Value |
|---|---|---|---|
| reference_movie_alias | Reference Movie Alias Type. If this parameter value set to non-default value then each output stream will be put to the separate file. | • 0 – None • 2 – Apple. Stream files will be put to the same directory as index file. • 3 – Omneon. Stream files will be put to the "media.dir" subdirectory. | 0 |
For reference_movie_alias and pack_files parameters
The <force_interlaced /> and <pack_files /> parameters supported only for the mov output format.
The <pack_files /> parameter will work only if <force_interlaced /> non-default value.
If <reference_movie_alias /> parameter set to non-default value and <pack_files /> set to no then parameter becomes required.
Complete Qualify template in QC job request
Added ability to set whole Qualify template JSON in AddMedia QC request
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>AddMedia</action>
<source>[SourceFile|SourcePlaylist]</source><!-- required -->
<format>
<output>[mp4|cablelabs_mpegts|mainconcept_mxf|mxf_op1a]</output><!-- required -->
<qc>
<qc_qualify_validation>
<template_json><![CDATA[
{
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
// package_layout params
},
"audio_layout": {
// audio_layout params
}
}
]]></template_json>
<!-- qc_qualify_validation -->
</qc_qualify_validation>
</qc>
<!-- format params -->
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "AddMedia", // required
"source": "[SourceFile|SourcePlaylist]", // required
"format": {
"output": "[mp4|cablelabs_mpegts|mainconcept_mxf|mxf_op1a]", // required
"qc": {
"qc_qualify_validation": {
"template_json": {
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
// package_layout params
},
"audio_layout": {
// audio_layout params
}
}
// qc_qualify_validation
}
}
// format params
}
}
}
<?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</output><!-- required -->
<source_options>
<qc>
<qc_qualify_validation>
<template_json><![CDATA[
{
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
// package_layout params
},
"audio_layout": {
// audio_layout params
}
}
]]></template_json>
<!-- qc_qualify_validation -->
</qc_qualify_validation>
</qc>
</source_options>
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "AddMedia", // required
"source": "[SourceFile|SourcePlaylist]", // required
"format": {
"output": "qc_check", // required
"source_options": {
"qc": {
"qc_qualify_validation": {
"template_json": {
"name": "[TemplateName]",
"tests": {
[TestsList]
},
"package_layout": {
// package_layout params
},
"audio_layout": {
// audio_layout params
}
}
// qc_qualify_validation params
}
}
}
}
}
}
| Parameter | Description | Allowed Values | Default Value |
|---|---|---|---|
| template_json | Qualify Template JSON | Valid JSON | none |
For template_json parameter
- If parameter <template_json /> specified then <template_id /> and <template /> parameters will be ignored.
- It's not possible to refer to saved audio and package layouts by <id /> parameter.
- Template specified in <template_json /> parameter not saved in database.
API Request to get Qualify template contents
Added API Request to fetch Qualify template contents.
View added template
Request:
<?xml version="1.0" encoding="UTF-8"?>
<query>
<userid><<id>></userid> <!-- required -->
<userkey><<key>></userkey> <!-- required-->
<action>GetQualifyTemplate</action> <!-- required-->
<template_id>[TemplateGUID]</template_id> <!-- required-->
<template_name>[TemplateName]</template_name> <!-- optional, deprecated-->
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "GetQualifyTemplate", // required
"template_id": "[TemplateGUID]", // required
"template_name": "[TemplateName]" // optional, deprecated
}
}
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<action>getqualifytemplate</action>
<status>Success</status>
<id>[TemplateGUID]</id>
<name>[TemplateName]</name>
<template>found</template>
<content><![CDATA[
{
"id": "[TemplateGUID]",
"name": "[TemplateName]",
"tests": {
[TestsList]
}
// template params
}
]]></content>
</response>
{
"response": {
"action": "getqualifytemplate",
"status": "Success",
"id": "[TemplateGUID]",
"name": "[TemplateName]",
"template": "found",
"content": {
"id": "[TemplateGUID]",
"name": "[TemplateName]",
"tests": {
[TestsList]
}
// template params
}
}
}