01 October 2020

Image Media Playlist for Repackaging

Added support of <image_media_playlist /> for the Intermediate Adaptive Output and the Repackaging from Intermediate Output.

Intermediate Adaptive Output

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[AddMedia|AddMediaBenchmark]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <multijob_workflow>[yes|no]</multijob_workflow>
    <format>
        <output>adaptive_intermediate</output>
        <!-- Destination fields -->
        <destination>[DestFile]</destination> <!-- required -->
        <image_media_playlist>
           <interval>[Interval]</interval>
           <layout>[Layout]</layout>
           <size>[Size]</size>
        </image_media_playlist>
        <image_media_playlist>
           <!-- image_media_playlist params -->
        </image_media_playlist>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[AddMedia|AddMediaBenchmark]", // required
        "source": "[SourceFile]", // required
        "multijob_workflow": "[yes|no]",
        "format": {
            "output": "adaptive_intermediate", // required
            "destination": "[DestFile]", // required
            "image_media_playlist": [
                {
                    "interval": "[Interval]",
                    "layout": "[Layout]",
                    "size": "[Size]"
                },
                {
                    // image_media_playlist params
                }
            ]
        }
    }
}

Repackaging from Intermediate Output

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[AddMedia|AddMediaBenchmark]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <!-- Multiple sorces may be included -->
    <source>[SourceFile]</source>
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]</output>
        <!-- Destination fields -->
        <destination>[DestFile]</destination> <!-- REQUIRED -->
        <!-- Multiple intermediate source map params may be included -->
        <intermediate_source_map>
            <source_id>[ID]</source_id> <!-- REQUIRED -->
            <stream_id>[ID]</stream_id>
            <alternate_id>[ID]</alternate_id>
            <program_segment_id>[ID]</program_segment_id>
            <image_media_playlist_id>[ID]</image_media_playlist_id>
        </intermediate_source_map>
        <intermediate_source_map>
            <!-- intermediate source map params -->
        </intermediate_source_map>
        <!-- Format fields -->
        <image_media_playlist>
            <sub_path>[SubPath]</sub_path>
            <base_name>[BaseName]</base_name>
            <no_ext_x_tiles>[yes|no]</no_ext_x_tiles>
            <!-- image_media_playlist params -->
        </image_media_playlist>
        <image_media_playlist>
            <!-- image_media_playlist params -->
        </image_media_playlist>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[AddMedia|AddMediaBenchmark]", // required
        "source": [ // required
            "[SourceFile]",
            "[SourceFile]"
        ],
        "format": {
            "output": "[advanced_hls|fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]", // required
            "destination": "[DestFile]", // required
            "intermediate_source_map": [
                {
                    "source_id": "[ID]", // required
                    "stream_id": "[ID]",
                    "alternate_id": "[ID]",
                    "program_segment_id": "[ID]",
                    "image_media_playlist_id": "[ID]"
                }
            ],
            "image_media_playlist": [
                {
                    "sub_path": "[SubPath]",
                    "base_name": "[BaseName]",
                    "no_ext_x_tiles ": "[yes|no]",
                },
                {
                    // image_media_playlist params
                }
            ]
        }
    }
}

Parameter

Description

Allowed Values

Default Value

image_media_playlist_id

Specify the image playlist tarball index number, to which
we will apply intermediate source specified in source_id.

non-negative integer

none

🚧

For image_media_playlist parameters

<interval />, <layout />, and <size /> options has no effect on the repackaging stage.

OIDC Refresh Token API Authentication

Added ability to link an account with OIDC Identity Provider and use a refresh token for authentication in API.

Authentication with a Refresh Token previously fetched from OIDC Identity Provider. For now, we support Okta as OIDC Identity Provider. Learn more about how to link OIDC Issuer and how to get Refresh Token in the related guide.

<?xml version="1.0"?>
<query>
    <oidc_refresh_token>[RefreshToken]</oidc_refresh_token> <!-- required-->
    <action>[Action]</action>
    <!-- query params -->
</query>
{
    "query": {
        "oidc_refresh_token": "[RefreshToken]", // required
        "action": "[Action]" // required
        // query params
    }
}

Parameter

Description

Allowed Values

Default Value

oidc_refresh_token

Refresh Token fetched from the OIDC Identity Provider.

String

none