GetPresetsList

This request returns a list of available output presets. This list includes both default and customer-generated 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]"
    }
}

Parameter

Description

Allowed Values

Default Value

type

Specify the preset type.

all — 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]"
                }
            ]
        }
    }
}

Parameter

Description

Allowed Values

Default Value

name

Specify the preset name.

String

None

type

Specify the preset type.

all — 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]"
    }
}