# Stream videos with on-demand encoding

Robot: `/video/ondemand`

🤖/video/ondemand generates HTTP Live Streaming (HLS) playlists and segments on-demand for adaptive and cost-efficient playback.

Stage: ga

## Usage example

Enable streaming of a video stored on S3 in three variants (480p, 720p, 1080p) with on-demand encoding:

```json
{
  "steps": {
    "import": {
      "credentials": "YOUR_AWS_CREDENTIALS",
      "path": "${fields.input}",
      "return_file_stubs": true,
      "robot": "/s3/import"
    },
    "serve": {
      "robot": "/file/serve",
      "use": "vod"
    },
    "vod": {
      "robot": "/video/ondemand",
      "use": "import",
      "variants": {
        "1080p": {
          "ffmpeg_stack": "v7",
          "preset": "hls/1080p"
        },
        "480p": {
          "ffmpeg_stack": "v7",
          "preset": "hls/480p"
        },
        "720p": {
          "ffmpeg_stack": "v7",
          "preset": "hls/720p"
        }
      }
    }
  }
}
```

## Parameters

<span aria-hidden="true" id="interpolate"></span>



### `interpolate`

Controls whether Assembly Variables are interpolated for individual instruction fields.

By default, most Robot instruction fields interpolate Assembly Variables. Set this to `false` to treat every instruction field as literal text, or set an individual field path to `false` to treat only that field as literal text. For Robot-specific fields that are literal by default, set this to `true` or set that field path to `true` to opt back into interpolation.

Use field names such as `path`, or dotted paths such as `ffmpeg.vf` for nested objects.

Type: `boolean | Record<string, boolean>`

<span aria-hidden="true" id="output_meta"></span>



### `output_meta`

Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

For images, you can add `"has_transparency": true` in this object to extract if the image contains transparent parts and `"dominant_colors": true` to extract an array of hexadecimal color codes from the image.

For images, you can also add `"blurhash": true` to extract a [BlurHash](https://blurha.sh) string — a compact representation of a placeholder for the image, useful for showing a blurred preview while the full image loads.

For images, `"thumbhash": true` instead extracts a base64-encoded [ThumbHash](https://evanw.github.io/thumbhash/) into `meta.thumbhash`, together with `meta.has_alpha` (whether an alpha channel exists, even when fully opaque). It describes EXIF-oriented pixels and uses the first frame of animated images. Extraction is best-effort: images above 40 megapixels, unsupported formats, or a failed/bounded decode produce no placeholder. Successful extraction adds a metadata charge equivalent to 20% of that file's bytes. No ThumbHash surcharge applies when disabled or when no hash is produced.

Set this option on the Step producing the image, such as `/upload/handle` for uploaded originals or `/image/resize` for processed outputs. Setting it only on `/transloadit/store` does not request extraction: storage preserves the producer's metadata. Transloadit Storage persists a generated hash with its immutable version and returns it in stored results and native asset reads. Direct S3 uploads do not generate placeholders. A placeholder contains image information, so protect it with the same access controls as the full image.

For videos, you can add the `"colorspace": true` parameter to extract the colorspace of the output video.

For videos, you can also add `"interlaced": true` to detect whether the video is interlaced. This combines the cheap ffprobe `field_order` flag with a bounded `idet` sampling pass over the first frames of the source, exposing `interlaced`, `field_order`, and a diagnostic `interlace_detection` object under `file.meta`. This is computationally expensive and billed accordingly.

For audio, you can add `"mean_volume": true` to get a single value representing the mean average volume of the audio file.

You can also set this to `false` to skip metadata extraction and speed up transcoding.

Type: `Record<string, boolean> | boolean | Array<string>`

<span aria-hidden="true" id="user_meta"></span>



### `user_meta`

Adds custom JSON metadata to each emitted file without changing its contents. Nested objects and arrays are supported.

Inheritance depends on the Robot. Values merge with existing `user_meta` on the output file; the current Step replaces matching top-level keys. Assign required keys explicitly when a Robot creates fresh outputs.

In processing Steps, `${file.*}` refers to the first input and `${result.*}` to the emitted file. Values are evaluated per output after the Robot runs, before subsequent metadata extraction and temporary storage. On `:original`, values are evaluated per upload before metadata extraction.

Downstream Steps read `${file.user_meta.key}`. See [Custom metadata](https://transloadit.com/docs/topics/assembly-variables.md#user-meta) for a complete example and inheritance rules.

Type: `Record<string, any>`

Default: `{}`

<span aria-hidden="true" id="result"></span>



### `result`

Whether the results of this Step should be present in the Assembly Status JSON

Type: `boolean`

Default: `false`

<span aria-hidden="true" id="queue"></span>



### `queue`

Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

Type: `batch`

<span aria-hidden="true" id="force_accept"></span>



### `force_accept`

Force a Robot to accept a file type it would have ignored.

By default, Robots ignore files they are not familiar with.
[🤖/video/encode](/docs/robots/video-encode.md), for
example, will happily ignore input images.

With the `force_accept` parameter set to `true`, you can force Robots to accept all files thrown at them.
This will typically lead to errors and should only be used for debugging or combatting edge cases.

Type: `boolean`

Default: `false`

<span aria-hidden="true" id="ignore_errors"></span>



### `ignore_errors`

Ignore errors during specific phases of processing.

Setting this to `["meta"]` will cause the Robot to ignore errors during metadata extraction.

Setting this to `["execute"]` will cause the Robot to ignore errors during the main execution phase.

Setting this to `true` is equivalent to `["meta", "execute"]` and will ignore errors in both phases.

Type: `boolean | Array<meta | execute>`

Default: `[]`

<span aria-hidden="true" id="use"></span>



### `use`

Specifies which Step(s) to use as input.

* You can pick any names for Steps except `":original"` (reserved for user uploads handled by Transloadit)
* You can provide several Steps as input with arrays:
  ```json
  {
    "use": [
      ":original",
      "encoded",
      "resized"
    ]
  }
  ```
* You can also tag input Steps with `as` to pass semantic intent to robots:
  ```json
  {
    "use": [
      {
        "name": ":original",
        "as": "image"
      },
      {
        "name": ":original",
        "as": "mask"
      }
    ]
  }
  ```

> [!Tip]
> That's likely all you need to know about `use`, but you can view [Advanced use cases](/docs/topics/use-parameter.md).

Type: `string | Array<string> | Array<object> | object`

<span aria-hidden="true" id="variants"></span>



### `variants`

Defines the variants the video player can choose from. The keys are the names of the variant as they will appear in the generated playlists and URLs.

Type: `Record<string, object>` — Required

<span aria-hidden="true" id="enabled_variants"></span>



### `enabled_variants`

Specifies which variants, defined in the variants parameter, are enabled. Non-enabled variants will not be included in the multivariant playlist.

Type: `string | Array<string>`

<span aria-hidden="true" id="segment_duration"></span>



### `segment_duration`

The duration of each segment in seconds.

Type: `string | number`

Default: `6`

<span aria-hidden="true" id="sign_urls_for"></span>



### `sign_urls_for`

When signing URLs is enabled, the URLs in the generated playlist files will be signed. This parameter specifies the duration (in seconds) that the signed URLs will remain valid. Use the modern `sig` + `exp` format for new integrations. Legacy `s` signatures are deprecated. Shorter expirations reduce the replay window, but they also reduce cache reuse and can increase segment re-generation and latency.

Type: `string | number`

Default: `0`

<span aria-hidden="true" id="asset"></span>



### `asset`

Controls which file is generated. For example, if the parameter is unset, a multivariant playlist referencing the variants is generated.

Type: `string`

<span aria-hidden="true" id="asset_param_name"></span>



### `asset_param_name`

Specifies from which URL parameter the asset parameter value is taken and which URL parameter to use when generating playlist files.

Type: `string`

Default: `"asset"`
