show¶

Show account conversion template information.

Parameters¶

template_key : string: Key of the conversion template.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <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>
    <watermark key="WAmK1Nj6">
      <link>
        <address>content.bitsontherun.com</address>
        <path>/watermarks/WAmK1Nj6.png</path>
        <protocol>http</protocol>
      </link>
      <margin>10</margin>
      <name>Watermark #1</name>
      <position>bottom-right</position>
    </watermark>
    <width>320</width>
  </template>
</response>

Response parameters¶

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

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

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

//template/width : unsigned integer: Video template width.

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

//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.

//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.

//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.

//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.

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

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

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

//template/watermark : string: Watermark used with this template. Included in response only when watermark status is ready or updating.

//template/watermark/@key : string: Watermark key.

//template/watermark/name: string: Name of the watermark.

//template/watermark/position : string

Watermark position:

top-left: Watermark positioned in the top left corner of the video.

top-right: Watermark positioned in the top right corner of the video.

bottom-right: Watermark positioned in the bottom right corner of the video.

bottom-left: Watermark positioned in the bottom left corner of the video.

center: Watermark positioned in the center of the video.

//template/watermark/margin : unsigned integer: Watermark margin from the both sides of the video corner set by the //watermark/position parameter.

//template/watermark/link : string: Watermark download link is split into 3 parts: protocol, address and path.

//template/watermark/link/protocol : string: Protocol part of the watermark download link.

//template/watermark/link/address : string: Address part of the watermark download link.

//template/watermark/link/path : string: Path part of the watermark download link.

previous page | Reference Overview |next page