Release NotesUser InterfaceSystem Status
Recent API Changes
Back to All

02 April 2020

over 4 years ago by Encoding.com Product Team #2

New encoder

Added new encoder version.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action>
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>[output]</output> <!-- required -->
        <encoder>edc1</encoder>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "addMedia", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[output]", // required
            "encoder": "[EncoderVersion]"
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
encoderSpecify which version of Encoding.com's engine to use.v1, v3, edc1v1

Image Media Playlists

Added ability to add Image Playlist for advanced multi-bitrate ouput formats.

Image Playlist specification developed by Disney and Warner Media defines a format using compressed graphic image files for HLS and DASH that provides a sparse track of video frames for a client to use during trick-play and seek operations. This alternative format uses image files that have been compressed (usually via commonly-employed encoding schemes, e.g., JPEG). The HLS EXT-X-IMAGE-STREAM-INF tag identifies an Image Media Playlist file containing Images in a compressed graphic image format. It stands alone, in that it does not apply to a particular URI in the Master Playlist. Read more in the specification.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></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-->
        <image_media_playlist>
           <!-- image_media_playlist doesn't work with advanced_mss -->
           <interval>[ImageInterval]</interval>
           <size>[ImageSize]</height>
           <width>[ImageWidth]</width>
           <height>[ImageHeight]</height>
           <layout>[ImagesLayout]</layout>
           <max_columns>[ColumnsPerTile]</max_columns>
           <max_rows>[RowsPerTile]</max_rows>
           <basename>[BaseName]</basename>
           <sub_path>[SubPath]</sub_path>
        </image_media_playlist>
        <image_media_playlist>
           <!-- image_media_playlist params -->
        </image_media_playlist>
        <!-- multiple image_media_playlist may be included -->
        <!-- Format params -->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[advanced_hls|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]", // required
            "destination": "[DestFile]", // required
            "image_media_playlist": [
                // image_media_playlist doesn't work with advanced_mss
                {
                    "interval": "[ImageInterval]",
                    "size": "[ImageSize]",
                    "width": "[ImageWidth]",
                    "height": "[ImageHeight]",
                    "layout": "[ImagesLayout]",
                    "max_columns": "[ColumnsPerTile]",
                    "max_rows": "[RowsPerTile]",
                    "basename": "[BaseName]",
                    "sub_path": "[SubPath]"
                },
                {
                    // image_media_playlist params
                }
                // multiple image_media_playlist may be included
            ],
            // Format Params
        }
    }
}

🚧

Note

Image Playlist Parameters feature doesn't work with advanced_mss output format.

ParameterDescriptionAllowed ValuesDefalt Value
intervalSpecify the time interval between images in seconds or percentage of time passed.N – Positive float number greater than 0.0111
sizeSpecify the image width and height.Pair of image width and height divided by ‘x’.none
widthSpecify the image width.Non-negative integer.160
heightSpecify the image height.Non-negative integer.none
layoutSpecify the playlist rows and columns layout.Rows and Columns number divided by ‘x’.none
max_columnsSpecify the number of columns per tile.Non-negative integer.none
max_rowsSpecify the number of rows per tile.Non-negative integer.none
sub_pathDirectory where images would be uploaded.
Relative to output destination.		Stringnone
basenameImage name prefixStringnone

🚧

For size parameter

<size /> parameter overwrites <width /> and <height /> parameters.

🚧

For layout parameter

<layout /> parameter overwrites <max_columns /> and <max_rows /> parameters.