Skip to main content


We support three ways of inputting a file for processing, you can give us a:

  • HTML File Object (Ideally use this when in the browser)
  • String containing the path to the file (Only available in Node.js environments)
  • A ModfyFile, basically a Buffer containing the bytes of the video passed in as an object like this: { name:string, buffer: Buffer }

All InputFiles must be of the same type, you can't mix and match types (yet ๐Ÿ˜‰).

Type Reference#

* This interface is a wrapper for a file object which takes a buffer
* with the mimeType and name of the file
type ModfyFile = {
name: string
mimeType?: string // You can optionally set the file type: video/mp4
buffer: Buffer
type StoredFiles = File[] | ModfyFile[]
* This type represents the accepted file inputs
* There are three accepted file input types
* 1. Array of Html File Object
* 2. Array of Strings, File Paths (Node only)
* 3. Array of {buffer, name, mimeType}
Here we are supporting buffers directly but require that you provide the name
type AcceptedFiles = StoredFiles | string[]