Encoding.com's API provides the ability to ingest Dolby Atmos master files (DAMF or ADM BWF) and produce Dolby Atmos (DolbyDigitalPlus Joint Object Coding) encoded audio streams in advanced_dash, advanced_fmp4, and fmp4_hls output formats.
<?xml version="1.0"?>
<query>
<userid>[UserID]</userid> <!-- required-->
<userkey>[UserKey]</userkey> <!-- required-->
<action>[Action]</action> <!-- required-->
<source>[SourceFile]</source> <!-- required-->
<format>
<output>[advanced_hls|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]</output> <!-- required-->
<destination>[DestFile]</destination> <!-- required-->
<stream>
<audio_only>yes</audio_only>
<audio_codec>eac3joc</audio_codec>
<!-- stream params -->
</stream>
<!-- Multiple stream params may be included in output format -->
<!-- Maximum number of available streams is 15 -->
<stream>
<!-- stream params -->
</stream>
<alternate_source>
<source>[FileURL]</source> <!-- ADM BWF File -->
<type>audio</type>
<audio_name>[Name]</audio_name>
<!-- alternate_source params -->
</alternate_source>
<alternate_source>
<source>[FileURL]</source> <!-- DAMF Atmos File -->
<damf_audio>[DAMFAudioURL]</damf_audio>
<damf_metadata>[DAMFMetadataURL]</damf_metadata>
<type>audio</type>
<audio_name>[Name]</audio_name>
<!-- alternate_source params -->
</alternate_source>
<alternate_source>
<!-- alternate_source params -->
</alternate_source>
<!-- Format params -->
</format>
</query>
{
"query": {
"userid": "[UserID]", // required
"userkey": "[UserKey]", // required
"action": "[Action]", // required
"source": "[SourceFile]", // required
"format": {
"output": "[advanced_dash|fmp4_hls|advanced_fmp4]", // required
"destination": "[DestFile]", // required
"stream": [
{
"audio_only": "yes",
"audio_codec": "eac3joc"
// stream params
},
{
// stream params
}
// Multiple stream params may be included in output format
// Maximum number of available streams is 15
],
"alternate_source": [
{
"source": "[FileURL]", // ADM BWF File
"type": "audio",
"audio_name": "[Name]",
"damf_audio": "[DAMFAudioURL]",
"damf_metadata": "[DAMFMetadataURL]"
// alternate_source params
},
{
"source": "[FileURL]", // DAMF Atmos File
"damf_audio": "[DAMFAudioURL]",
"damf_metadata": "[DAMFMetadataURL]",
"type": "audio",
"audio_name": "[Name]"
// alternate_source params
},
{
// alternate_source params
}
// multiple alternate_sources may be included
],
// Format Params
}
}
}
Parameter | Description | Allowed Values | Default Value |
---|---|---|---|
audio_codec | Specify the audio codec | advanced_hls, fmp4_hls, advanced_dash, advanced_fmp4: eac3joc | advanced_hls, fmp4_hls, advanced_dash, advanced_fmp4: libfaac |
damf_audio | DAMF Audio aux file | Valid URL | none |
damf_metadata | DAMF Metadata aud file | Valid URL | none |
Alternate Source Parameters | - | - | - |
Format Parameters | - | - | - |
Dolby Atmos DAMF files
Dolby Atmos DAMF alternate source files are:
- <source /> – XML .atmos file with DAMF file description (framerate, beds and objects number, FFoA, start time offset etc)
- <damf_metadata /> – XML .atmos.metadata file with objects size and position (xyz) coordinates over time
- <damf_metadata /> – CAF (Core Audio FIle) file .atmos.audio It may contains up to 128 tracks.