yospaceCDS Transcoding Hub Conversion ID Reference

Standard Conversion IDs are provided below.  Please see below for information on additional parameters.

Please note: This page relates to transcoding profiles relating to the low-level yospaceCDS Web Services API and is only relevant to parties using this API. The yospaceCDS Mobile Delivery Solution performs automatic format conversion based on the device accessing the video.

Special Functions

0000: Canonical Upload

Performs asynchronous upload of media content and stores it as the 'canonical' data.

Required Parameter:

• LOCATION -- the URL from where the content can be fetched.

Optional Parameters:

• MAX_CONNECT_TIME - The maximum time in seconds to establish an HTTP connection. Default 30 secs, maximum permitted value 120 secs.
• MAX_TRANSFER_TIME - The maximum time in seconds to complete a single HTTP transfer attempt. Default 900 secs, maximum permitted value 3600 secs (1 hour).
• MIN_TRANSFER_RATE - The minimum acceptable transfer rate in bytes / second. Default 1024 bytes / second, maximum permitted value 256000 (256K/ps).
• MIN_TRANSFER_RATE_PERIOD - The period over which the minimum acceptable rate is assessed. Default 60 secs, minimum value 15 secs.
• RETRY_COUNT - The number of attempts to try the transfer before giving up. Default 5, maximum permitted value 10.
• RETRY_DELAY - The time in seconds between transfer retries. Default 30 secs, minimum permitted value 5 secs.
• MAX_RETRY_TIME - The maximum time in seconds to attempt all tries before giving up completely. Default 1800 secs, maximum permitted value 5400 secs (1.5 hours).

9000: FTP Upload

Uploads a specific format (conversion ID and variant) to the specified destination via FTP. If the format requested by this conversion and variant does not exist, the upload will fail. On failure, the string UPLOAD_ERROR will be returned to the failure notification URL.

Required Parameters:

• CONVERSION_ID: the Conversion ID that is to be uploaded.
• LOCATION: full FTP URL, including authentication information, path and filename. For example, ftp://foo:bar@ftp.yospace.com/videos/MyVideo.3gp
  If you do not specify the destination filename, the file will be named u-<CONVERSION ID>-<VARIANT>

Optional Parameters:

• CREATE_DIRS -- (use any value) the upload will create the directories to create the path you specify if they do not already exist. The default behaviour (not specifying this parameter) is to fail if the path specified does not exist.
• MAX_CONNECT_TIME - The maximum time in seconds to establish an FTP connection. Default 30 secs, maximum permitted value 120 secs.
• MAX_TRANSFER_TIME - The maximum time in seconds to complete a single FTP transfer attempt. Default 300 secs, maximum permitted value 3600 secs (1 hour).
• MIN_TRANSFER_RATE - The minimum acceptable transfer rate in bytes / second. Default 1024 bytes / second, maximum permitted value 256000 (256K/ps).
• MIN_TRANSFER_RATE_PERIOD - The period over which the minimum acceptable rate is assessed. Default 60 secs, minimum value 15 secs.
• RETRY_COUNT - The number of attempts to try the transfer before giving up. Default 5, maximum permitted value 10.
• RETRY_DELAY - The time in seconds between transfer retries. Default 30 secs, minimum permitted value 5 secs.
• MAX_RETRY_TIME - The maximum time in seconds to attempt all tries before giving up completely. Default 600 secs, maximum permitted value 5400 secs (1.5 hours).

9999: Single Frame Thumbnailer

By default, creates a JPEG thumbnail of the first frame of the video, at the original size of the video.

Optional Parameters:

• STARTPOINT -- The start point at which the frame is grabbed. If the starting point from which the frame is to be taken is beyond the length of the file, the first frame is used instead.
• SIZE -- The frame size of the thumbnail, this can be specified in multiple ways:
  • x[HEIGHT] (e.g. x300) - the image will be scaled to be the specified height retaining its native aspect ratio
  • [WIDTH]x (e.g. 300x) - the image will be scaled to be the specified width retaining its native aspect ratio
  • [WIDTH]x[HEIGHT] (e.g. 500x300) - the image will be scaled and letter or pillar boxed to fit in the specified rectangle retaining its native aspect ratio.  In this case a 4:3 image will be returned as 400x300 as this is the largest 4x3 image that fits within 500x300
  • [WIDTH]x[HEIGHT]! (e.g. 500x300!) - the image will be scaled as stretched to fit exactly into the specified rectangle
• DEFAULT_IMAGE_URL -- Specifies the URL of a default image to use if the content on which you are calling the thumbnail has no video track.

Common Crop Parameters

The following parameters can be used to crop pixels from the input frame. This is particularly useful when converting broadcast video that is intended to be overscanned.

Precedence

It is possible to specify any combination of cropping parameter. Where a conflict occurs it is resolved using the following precedence from lowest to highest priority.

• CROP_ALL
• CROP_VERTICAL, CROP_HORIZONTAL
• CROP_TOP, CROP_BOTTOM, CROP_LEFT, CROP_RIGHT