Presets Resource


The Presets resource defines conversion "presets". A preset fully specifies all the codecs and audio/video parameters necessary to perform a successful video format conversion. 
You must provide an ID of a stored Preset upon making a POST request to the Jobs resource in order to launch a new conversion job. You can also use the Web UI by clicking the "Presets" tab on your dashboard to edit your existing Presets or create a new custom Preset.

There are currently two type of Presets

  1. System Presets 
    Those are the presets pre-defined as defaults within the system. Each newly registered user gets access to all the system presets automatically. To view these presets you don't need to have any special OAuth access_token. You cannot modify or delete system presets.

  2. Custom Presets
    You can customize system presets or create new ones from scratch. Presets must always reference to one video and/or one audio codec and specify also the container format and file ending that the output files converted with this preset shall have. Using a custom Preset, you can set custom max values for properties of the referenced codecs and make them more restrictive. Further, you can pre-set more concrete values for video or audio conversion settings (e.g. you can specify the desired quality level for the converted video/audio output, enable deinterlacing and choose among image resizing options). All settings in the Preset must be within globally allowed value ranges and within the specific bounds laid out by the selected codecs' properties.

Any settings given for codec_caps must match the Codecs type. So you cannot set audio properties for a codec that is of type "video" or vice versa. Doing it wrongly will cause an "invalid input" error. You can also only set properties that are available within the chosen codec's capabilities (e.g. you cannot set properties to the VP8 encoder that actually are specific to only the H.264 encoder).

"Container" can be set only to a value that both codecs selected (audio and video) support, so the chosen container must be listed in both codecs' "container" list. 

Presets must reference either one or two codecs. Specifying more or less codecs than this is invalid. Further, Presets cannot reference two codecs of the same type (= a Preset cannot have two audio codecs). If the Preset specifies only an audio or only a video codec but is used to convert input that has tracks of multiple type (so e.g. has both an audio and a video track), those input tracks for which no matching codec was specified in the preset will be discarded upon conversion. 

Access token is required to view custom presets. Custom Preset can be modified or deleted with a valid access_token.


Available Methods

 

  • No labels