Zencoder Encoding Settings: Aspera

Product(s)
Zencoder
Role(s)
API Developer
Topic(s)
Encoding Settings
API(s)
Zencoder API

This topic contains details for encoding settings related to Aspera.

Overview

Aspera provides an alternative, high-speed file transfer protocol as an alternative to protocols like FTP and HTTP.

To use Aspera specify an Aspera url with the path to the file.

This is a similar situation to you running an FTP server to make your files available and Zencoder using an FTP client for file transfer.

aspera_transfer_policy

aspera_transfer_policy:String

API Versions: V1, V2

Parent: outputs

Default: fair

Valid Values: fair or low

Compatible Job Types: All

Example: low

Description:

Sets how Zencoder will use the available bandwidth of the encoding server when transferring files to your Aspera server.

Fair splits bandwidth evenly between all running jobs on the encoding server.

Low uses any available bandwidth on the encoding server, but will give priority to other jobs. Low is useful if you are concerned about overrunning your server with too much traffic.

Note: The High option in Aspera is not supported in Zencoder. By default we will use as much bandwidth as possible, but will not prioritize access to bandwidth for one job over all others on an encoding server.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "aspera_transfer_policy": "low"
    }
  ]
}

See Also: transfer_minimum_rate and transfer_maximum_rate

transfer_minimum_rate

transfer_minimum_rate:Number

API Versions: V1, V2

Parent: outputs

Default: 1000

Valid Values: 1000-249999

Compatible Job Types: All

Example: 2500

Description:

Sets a transfer rate floor to use during file transfer with Aspera. This does not guarantee the rate will be reached, but if bandwidth is available then file transfer will not go below this speed.

This must be less than transfer_maximum_rate.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "transfer_minimum_rate": 2500
    }
  ]
}

See Also: transfer_minimum_rate and aspera_transfer_policy

transfer_maximum_rate

transfer_maximum_rate:String

API Versions: V1, V2

Parent: outputs

Default: 250000

Valid Values: 1001-250000

Compatible Job Types: All

Example: 25000

Description:

Sets a transfer rate ceiling to use during file transfer with Aspera. This does not guarantee the rate will be reached, but if bandwidth is available then file transfer will not go above this speed.

Setting maximum transfer rate is recommended when encoding a large number of jobs simultaneously, to avoid overwhelming the source and destination servers with traffic.

This must be greater than transfer_minimum_rate.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "transfer_maximum_rate": 25000
    }
  ]
}

See Also: transfer_maximum_rate and aspera_transfer_policy