show¶

Show video conversion information.

Parameters¶

conversion_key : string: Key of the conversion which information to show.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <conversion key="SjwIOMZV">
    <duration>12.00</duration>
    <filesize>639173</filesize>
    <height>180</height>
    <link>
      <protocol>http</protocol>
      <address>content.bitsontherun.com</address>
      <path>/originals/BvbnBjB6.mp4</path>
    </link>
    <mediatype>video</mediatype>
    <status>Ready</status>
    <template key="zYEm0xvS">
      <format key="original">
        <name>Original</name>
      </format>
      <name>Original</name>
      <required>True</required>
    </template>
    <width>320</width>
  </conversion>
  ...
</response>

Response parameters¶

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

/response/conversion/@key : string: Key of the conversion for which information is shown.

//conversion/mediatype : string

Conversion media type:

audio: Conversion media type is audio.

video: Conversion media type is video.

//conversion/status : string

Conversion status:

Waiting for original: Waiting when upload of the original video file is finished.

Queued: Conversion is in the conversion queue.

Encoding: Conversion is encoding.

Re-encoding: Conversion is re-encoding.

Uploading to CDN: Conversion is uploading to the CDN.

Ready: Conversion is ready and can be streamed.

Failed: Failed to encode the conversion.

Upload to CDN failed: Failed to upload conversion to the CDN.

//conversion/duration : float: Duration of the conversion in seconds. Set to -1 if conversion duration in unknown.

//conversion/filesize : unsigned integer: Size of the conversion in bytes. Set to -1 if conversion file size in unknown.

//conversion/width : unsigned integer: Conversion width. Set to -1 if conversion width in unknown.

//conversion/height : unsigned integer: Conversion height. Set to -1 if conversion height in unknown.

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

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

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

//conversion/template/format/@key : string

Key of the video format used for this template:

flv: FLV Video format.

mp4: H.264 format.

ogg: Ogg Theora/Vorbis format.

mp3: MP3 Audio format.

passthrough: Passthrough format.

original: Original unmodified video format.

See the list of supported output formats for more information.

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

//conversion/error : string: Conversion error. Included in response only when conversion status is Failed.

//conversion/error/@id : unsigned integer: Conversion error ID.

//conversion/error/message : string: Conversion error message.

//conversion/link : string: Conversion download link split into 3 parts: protocol, address and path. Included in response only when conversion status is Ready.

//conversion/link/protocol : string: Protocol part of the conversion download link.

//conversion/link/address : string: Address part of the conversion download link.

//conversion/link/path : string: Path part of the conversion download link.

previous page | Reference Overview |next page