Release NotesUser InterfaceSystem Status

SavePreset

Create or update a named preset which can be applied as a template for future jobs.

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": {
            "output": "[output]"
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
name Specify the preset name.StringIf not specified, preset name will be based on output name.
format Specify the preset format.Same as AddMedia sectionNone

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

Presets can also be saved using an AddMedia request by specifying the preset name in the <save_preset> parameter in the section of the request. An example is below.

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": {
            "output": "[output]",
            "save_preset": "[PresetName]"
        }
    }
}

Response

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

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