list¶

List available account conversion templates.

Parameters¶

order_by (optional) : string

Specifies parameters by which returned result should be ordered. Parameter sort order can be specified by appending :asc for an ascending sort order or :desc for a descending one to the parameter name. Default sort order is ascending and can be omitted. Multiple parameters should be separated by comma.

Result can be ordered by the following parameters: key, name, audio_quality, video_quality, width, upscale, default and required. Default is name:asc.

result_limit (optional): unsigned integer: Specifies maximum number of conversion templates to return. Default is 50. Maximum result limit is 1000.

result_offset (optional): unsigned integer: Specifies how many conversion templates should be skipped at the beginning of the result set. Default is 0.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <limit>50</limit>
  <offset>0</offset>
  <total>6</total>
  <templates total="6">
    <template key="BzV8dMpX">
      <default>all</default>
      <format key="original">
        <name>Original</name>
      </format>
      <min_scale_width />
      <name>Original</name>
      <quality>
        <audio>5</audio>
        <video>5</video>
      </quality>
      <required>True</required>
      <upscale>False</upscale>
      <width>320</width>
    </template>
    ...
  </templates>
</response>

Response parameters¶

/response/status : string: Call execution status. Set to ok if call executed successfully.

/response/limit : unsigned integer: Maximum number of conversion templates that should be return. As specified in the result_limit request parameter.

/response/offset : unsigned integer: Number of conversion templates that should be skipped at the beginning of the result set. As specified in the result_offset request parameter.

/response/total : unsigned integer: Total number of conversion templates.

/response/templates/@total : unsigned integer: Total number of returned conversion templates.

//template/@key : string: Key of the conversion template.

//templates/template/name : string: Name of the conversion template.

//templates/template/width : unsigned integer: Conversion template width.

//templates/template/required : string: True if template is a required template, False otherwise.

//templates/template/default : string

Specifies if template is applied by default to the new video or audio uploads:

video: Applied by default only to new video uploads.

audio: Applied by default only to new audio uploads.

all: Applied by default to all new uploads.

none: Does not applied by default to new uploads.

//templates/template/upscale : string: True if template is applied to videos that are smaller than the template’s width (or min_scale_width if given), False otherwise.

//templates/template/min_scale_width : integer: If this is given and upscale is False, this template is only applied to videos whose width is smaller than this value.

//templates/template/format/@key : string

Key of the video format used for this template:

flv

H.263 video and MP3 audio in Flash Video container.

mp4

H.264 video and AAC audio in MP4 container.

ogg

Theora video and Vorbis audio in Ogg container.

webm

VP8 video and Vorbis audio in WebM container.

mp3

MP3 audio.

aac

AAC audio in MP4 container.

vorbis

Vorbis audio in Ogg container.

passthrough

Passthrough format.

original

Original unmodified video or audio.

See the list of supported output formats for more information.

//templates/template/format/name : string: Name of the video format used for this template.

//templates/template/quality/audio : unsigned integer: Template audio quality settings.

//templates/template/quality/video : unsigned integer: Template video quality settings.

previous page | Reference Overview |next page