Release NotesUser InterfaceSystem Status
Recent API Changes
Back to All

20 June 2016 - Custom Presets Management, Custom destination content type, and Reserved Instances Info

over 8 years ago by Encoding.com Product Team

Reserved Instances Info

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>getReservedInfo</action>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "getReservedInfo"
    }
}

Response:

<?xml version="1.0"?>
<response>
    <action>getreservedinfo</action>
    <status>Success</status>
    <result>
        <total_threads>[TotalThreadsCount]</total_threads>
        <processing_threads>[ProcessingTasksThreads]</processing_threads>
        <failovers_threads>[FailoveredTasksTheads]</failovers_threads>
        <waiting_threads>[WaitingTasksTheads]</waiting_threads>
        <iddle_threads>[IddleTasksThreads]</iddle_threads>
    </result>
</response>

{
    "response": {
        "action": "getreservedinfo",
        "status": "Success",
        "result": {
            "total_threads": "[TotalThreadsCount]",
            "processing_threads": "[ProcessingTasksThreads]",
            "failovers_threads": "[FailoveredTasksTheads]",
            "waiting_threads": "[WaitingTasksTheads]",
            "iddle_threads": "[IddleTasksThreads]"
        }
    }
}

Custom destination content type

Destination typeDescription
Amazon Web Services (S3)

Custom and UI Presets as output

You can use your own custom preset or Encoding.com UI presets as output format.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action>
    <format> <!-- REQUIRED -->
        <output_preset>[output]</output_preset> <!-- REQUIRED -->
        [FormatParams]
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "addMedia",
        "format": {
            "_": "[FormatParams]",
            "output_preset": "[output]"
        }
    }
}

Custom Presets Management: GetPresetList

This request returns list of available format presets

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>GetPresetsList</action>
    <type>[all|user|ui]</type> <!-- Optional -->
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "GetPresetsList",
        "type": "[all|user|ui]"
    }
}
Field NameDescriptionAllowed ValuesDefault Values
typePreset typeall — all available presets
user — user's custom presets
ui — predefined encoding's presets		all

Response:

<?xml version="1.0"?>
<response>
    <user>
        <preset>
            <name>[PresetName]</name>
            <type>user</type>
            <output>[PresetOutput]</output>
            <format>[Format Params]</format>
        </preset>
        <preset><!-- ... --></preset>
    </user>
    <ui>
        <preset>
            <name>[PresetName]</name>
            <type>ui</type>
            <output>[PresetOutput]</output>
            <format>[Format Params]</format>
        </preset>
        <preset><!-- ... --></preset>
    </ui>
</response>

{
    "response": {
        "user": {
            "preset": [
                {
                    "name": "[PresetName]",
                    "type": "user",
                    "output": "[PresetOutput]",
                    "format": "[Format Params]"
                },
                ""
            ]
        },
        "ui": {
            "preset": [
                {
                    "name": "[PresetName]",
                    "type": "ui",
                    "output": "[PresetOutput]",
                    "format": "[Format Params]"
                },
                ""
            ]
        }
    }
}

Custom Presets Management: GetPreset

This request returns preset's information

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>GetPreset</action>
    <name>[PresetName]</name> <!-- REQUIRED -->
    <type>[all|user|ui]</type> <!-- Optional -->
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "GetPreset",
        "name": "[PresetName]",
        "type": "[all|user|ui]"
    }
}
Field NameDescriptionAllowed ValuesDefault Values
namePreset nameString
typePreset typeall — all available presets
user — user's custom presets
ui — predefined encoding's presets		all

Response:

<?xml version="1.0"?>
<response>
    <name>[PresetName]</name>
    <type>[user|ui]</type>
    <output>[PresetOutput]</output>
    <format>[Format Params]</format>
</response>

{
    "response": {
        "name": "[PresetName]",
        "type": "[user|ui]",
        "output": "[PresetOutput]",
        "format": "[Format Params]"
    }
}

Custom Presets Management: SavePreset

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>savePreset</action>
    <name>[PresetName]</name>
    <format> <!-- REQUIRED -->
        <output>[output]</output> <!-- REQUIRED -->
        [FormatParams]
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "savePreset",
        "name": "[PresetName]",
        "format": {
            "_": "[FormatParams]",
            "output": "[output]"
        }
    }
}
Field NameDescriptionAllowed ValuesDefault Values
namePreset nameStringIf not specified, preset name would be generated from format output
formatPreset formatSame as AddMedia section

Response:

<?xml version="1.0"?>
<response>
    <message>Saved</message>
    <SavedPreset>[PresetName]</SavedPreset>
    <SavedPreset><!-- Each specified format would be saved as separate preset --></SavedPreset>
</response>

{
    "response": {
        "message": "Saved",
        "savedpreset": [
            "[PresetName]"
        ]
    }
}

📘

Note

also you could save preset in AddMedia request by specifying preset name in <save_preset> parameter in block.

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action>
    <format> <!-- REQUIRED -->
        <output>[output]</output> <!-- REQUIRED -->
        [FormatParams]
        <save_preset>[PresetName]</save_preset>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "addMedia",
        "format": {
            "_": "[FormatParams]",
            "output": "[output]",
            "save_preset": "[PresetName]"
        }
    }
}

Response:

<?xml version="1.0"?>
<response>
    <message>[ResponseMessage]</message>
    <SavedPreset>[PresetName]</SavedPreset>
</response>

{
    "response": {
        "message": "[ResponseMessage]",
        "savedpreset": "[PresetName]"
    }
}

Custom Presets Management: DeletePreset

Request:

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- REQUIRED -->
    <userkey><<key>></userkey> <!-- REQUIRED -->
    <action>deletePreset</action>
    <name>[PresetName]</name> <!-- REQUIRED -->
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "deletePreset",
        "name": "[PresetName]"
    }
}
Field NameDescriptionAllowed ValuesDefault Values
namePreset nameStringIf not specified, preset name would be generated from format output

Response:

<?xml version="1.0"?>
<response>
    <message>Deleted</message>
</response>

{
    "response": {
        "message": "Deleted"
    }
}