17 July 2020
almost 4 years ago by Encoding.com Product Team #2
Output Summary (Output JSON)
Added option to get output processing summary in JSON format as file or in notification body.
Request Sample
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>[Action]</action> <!-- required-->
<source>[SourceFile]</source> <!-- required-->
<extended_notify>[yes|no]</extended_notify>
<format>
<output>[advanced_hls|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]</output> <!-- required-->
<destination>[DestFile]</destination> <!-- required-->
<!-- multiple image_media_playlist may be included -->
<output_json>[yes|OutputJSONURL_1]</output_json>
<output_json>[yes|OutputJSONURL_2]</output_json>
<!-- ... -->
<output_json>[yes|OutputJSONURL_N]</output_json>
<!-- multiple output_json parameters may be included -->
<!-- Format params -->
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "[Action]", // required
"source": "[SourceFile]", // required
"extended_notify": "[yes|no]", // required
"format": {
"output": "[advanced_hls|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]", // required
"destination": "[DestFile]", // required
// format params
"output_json": [
"[yes|OutputJSONURL_1]",
"[yes|OutputJSONURL_2]",
// ...
"[yes|OutputJSONURL_N]"
// multiple output_json parameters may be included
]
}
}
}
| Parameter | Description | Allowed Values | Default Value |
|---|---|---|---|
| extended_notify | Add output_json data to the Notification response body. | yes, no | none |
| output_json | Upload output format processing summary to the output destination or the specified URL | yes, Valid URL | none |
Output JSON Sample
{
"output": [
{
"output": "[OutputName]",
"total-duration": "[Duration]",
"content-segments": [
{
"segment-idx": "[SegmentID]",
"start": "[Start]",
"duration": "[Duration]"
},
{
// segment parameters
}
],
"master-playlists": [
{
"name": "[PlaylistName]",
"type": "[Type]",
"avmux": [true|false], // playlist contains stram with muxed audio and video
"media-container": "[mp4|ts]",
"encryption": [true|false],
"drm-widevine": [true|false],
"drm-playready": [true|false],
"drm-access": [true|false], // may not be included
"drm-fairplay": [true|false], // may not be included
"drm-clearkey": [true|false], // may not be included
"asset-id": "[AssetID]",
"bucket-url": "[ManifestDestination]",
"thumbnail-playlist": {
"image-media-playlist": [
{
"interval": "[ThumbnailInterval]",
"resolution": "[ThumbnailSize]",
"bucket-url": [
"[PlaylistDestination_1]",
"[PlaylistDestination_2]",
// ...
"[PlaylistDestination_N]"
]
},
{
// image-media-playlist params
}
],
"iframe-playlist": [ // will be included only for hls manifests
{
"codecs": [
"[CodecName_1]",
"[CodecName_2]",
// ...
"[CodecName_N]"
],
"resolution": "[ThumbnailSize]",
"bucket-url": [
"[PlaylistDestination_1]",
"[PlaylistDestination_2]",
// ...
"[PlaylistDestination_N]"
]
},
{
// iframe-playlist params
}
],
},
"streams": [
{
"type": "[audio|video|muxed]",
"base_name": "[BaseName]",
"bitrate": "[BitRate]",
"codecs": [
"[CodecName_1]",
"[CodecName_2]",
// ...
"[CodecName_N]"
],
"video_bitrate": "[VideoBitRate]", // not be included for audio only
"width": "[Width]", // not be included for audio only
"height": "[Height]", // not be included for audio only
"level": "[VideoLevel]", // not be included for audio only
"profile": "[ProfileName]", // not be included for audio only
"audio_bitrate": "[AudioBitRate]", // not be included for video only
"sample_rate": [SampleRate], // not be included for video only
"channels": [ChannelsNumber] // not be included for video only
},
{
// stream params
}
]
},
{
// playlist params
}
]
}
]
}