Encoding.com API Documentation

The Encoding.com API

Welcome to the EDC developer hub. You'll find comprehensive guides and documentation to help you start working with EDC as quickly as possible, as well as support if you get stuck. Let's jump right in!

API Reference    

20 April 2020

7 months ago by Encoding.com Product Team #2

Ludicrous Mode support for Adaptive Intermediate

Add support of adaptive_intermediate for the media with Ludicrous Mode.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required -->
    <action>AddMedia</action> <!-- required -->
    <source>[SourceURL]</source> <!-- required -->
    <ludicrous_mode>[yes|no]</ludicrous_mode>
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_dash|advanced_fmp4|mp4|adaptive_intermediate]</output> 
        <destination>[DestinationURL]</destination> <!-- required -->
        <!-- Format params -->
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "AddMedia", // required
        "source": "[SourceURL]", // required
        "ludicrous_mode": "[yes|no]",
        "format": {
            "output": "[advanced_hls|fmp4_hls|advanced_dash|advanced_fmp4|mp4|adaptive_intermediate]",
            "destination": "[DestinationURL]" // required
            // Format params
        }
    }
}

🚧

Note

For now Ludicrous Mode only available for advanced_hls, fmp4_hls, advanced_dash, advanced_fmp4, mp4, and adaptive_intermediate output formats.

Media Notification via Amazon SNS

Added support of Amazon SNS topic as media notification endpoint.

<?xml version="1.0"?>
<query>
    <!-- Main params -->
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required -->
    <action>[Action]</action> <!-- required -->
    <source>[SourceFile]</source> <!-- required -->
    <notify_format>[xml|json]</notify_format>
    <notify>arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]</notify>
    <notify_encoding_errors>arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]</notify_encoding_errors>
    <notify_upload>arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]</notify_upload>
    <notify_upload_extended>[yes|no]</notify_upload_extended>
    <notify_live_start>arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]</notify_live_start>
    <qc_notify>arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]</qc_notify>
    <format> <!-- required -->
        <!-- Format params -->
    </format> 
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "notify_format": "[xml|json]",
        "notify": "arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]",
        "notify_encoding_errors": "arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]",
        "notify_upload": "arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]",
        "notify_upload_extended": "[yes|no]",
        "notify_live_start": "arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]",
        "qc_notify": "arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]",
        "format": [ // required
             {
                 // Format params
             }
        ]
    }
}

URL Format

Type

Format

AWS SNS Topic

arn:aws:sns:[Region]:[AWSAccountID]:[TopicName]

Amazon SNS Configuration

Here are a few steps that will help you to set up Amazon SNS topics.

  1. Go to the AWS SNS console
  2. Select region
  3. Create new Topic
  4. Set Publish access for all aws customers or for arn:aws:iam::456240961796:user/edc-manage
    JSON policy:{ "Sid": "__console_pub_0", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::456240961796:user/edc-manage" }, "Action": "SNS:Publish", "Resource": "%TopicARN%" }
  5. Add subscriptions. Don't forget to confirm these subscriptions.

More information about how to use Amazon SNS you can read in the official documentation.

👍

Note

You can use any supported region for the Amazon SNS topic. It shouldn't be the same as the media processing region.
Supported regions:

  • ap-east-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ca-central-1
  • eu-central-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • fips-us-east-1
  • fips-us-east-2
  • fips-us-west-1
  • fips-us-west-2
  • me-south-1
  • sa-east-1
  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2