Skip to content

Latest commit

 

History

History
419 lines (304 loc) · 15.7 KB

transloadit.md

File metadata and controls

419 lines (304 loc) · 15.7 KB
Raw
type order title module permalink category tagline
docs
10
Transloadit
@uppy/transloadit
docs/transloadit/
File Processing
manipulate and transcode uploaded files using the <a href='https://transloadit.com'>transloadit.com</a> service

The @uppy/transloadit plugin can be used to upload files to Transloadit for all kinds of processing, such as transcoding video, resizing images, zipping/unzipping, and much more.

If you’re okay to trade some flexibility for ergonomics, consider using the Robodog Plugin instead, which is a higher-level abstraction for encoding files with Uppy and Transloadit.

Try it live

import Transloadit from '@uppy/transloadit'

uppy.use(Transloadit, {
  service: 'https://api2.transloadit.com',
  params: null,
  waitForEncoding: false,
  waitForMetadata: false,
  importFromUploadURLs: false,
  alwaysRunAssembly: false,
  signature: null,
  fields: {},
  limit: 0,
})

As of Uppy version 0.24, the Transloadit plugin includes the Tus plugin to handle the uploading, so you no longer have to add it manually.

Installation

This plugin is published as the @uppy/transloadit package.

Install from NPM:

npm install @uppy/transloadit

In the CDN package, the plugin class is available on the Uppy global object:

const { Transloadit } = Uppy

Hosted Companion Service

You can use this plugin together with Transloadit’s hosted Companion service to let your users import files from third party sources across the web. To do so each provider plugin must be configured with Transloadit’s Companion URLs:

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit'
import Dropbox from '@uppy/dropbox'

uppy.use(Dropbox, {
  companionUrl: COMPANION_URL,
  companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
})

This will already work. Transloadit’s OAuth applications are used to authenticate your users by default. Your users will be asked to provide Transloadit access to their files. Since your users are probably not aware of Transloadit, this may be confusing or decrease trust. You may also hit rate limits, because the OAuth application is shared between everyone using Transloadit.

To solve that, you can use your own OAuth keys with Transloadit’s hosted Companion servers by using Transloadit Template Credentials. Create a Template Credential on the Transloadit site. Select “Companion OAuth” for the service, and enter the key and secret for the provider you want to use. Then you can pass the name of the new credentials to that provider:

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit'
import Dropbox from '@uppy/dropbox'

uppy.use(Dropbox, {
  companionUrl: COMPANION_URL,
  companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
  companionKeysParams: {
    key: 'YOUR_TRANSLOADIT_API_KEY',
    credentialsName: 'my_companion_dropbox_creds',
  },
})

Static exports

COMPANION_URL

The main endpoint for Transloadit’s hosted companions. You can use this constant in remote provider options, like so:

import Dropbox from '@uppy/dropbox'
import { COMPANION_URL } from '@uppy/transloadit'

uppy.use(Dropbox, {
  companionUrl: COMPANION_URL,
})

When using COMPANION_URL, you should also configure companionAllowedHosts: COMPANION_ALLOWED_HOSTS.

The value of this constant is https://api2.transloadit.com/companion. If you are using a custom service option, you should also set a custom host option in your provider plugins, by taking a Transloadit API url and appending /companion:

uppy.use(Dropbox, {
  companionUrl: 'https://api2-us-east-1.transloadit.com/companion',
})

COMPANION_ALLOWED_HOSTS

A RegExp pattern matching Transloadit’s hosted companion endpoints. The pattern is used in remote provider companionAllowedHosts options, to make sure that third party authentication messages cannot be faked by an attacker’s page, but can only originate from Transloadit’s servers.

Use it whenever you use companionUrl: COMPANION_URL, like so:

import Dropbox from '@uppy/dropbox'
import { COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit'

uppy.use(Dropbox, {
  companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
})

The value of this constant covers all Transloadit’s Companion servers, so it does not need to be changed if you are using a custom service option. But, if you are not using the Transloadit Companion servers at *.transloadit.com, make sure to set the companionAllowedHosts option to something that matches what you do use.

Options

The @uppy/transloadit plugin has the following configurable options:

id: 'Transloadit'

A unique identifier for this plugin. It defaults to 'Transloadit'.

service

The Transloadit API URL to use. It defaults to https://api2.transloadit.com, which will try to route traffic efficiently based on the location of your users. You can set this to something like https://api2-us-east-1.transloadit.com if you want to use a particular region.

params

The Assembly parameters to use for the upload. See the Transloadit documentation on Assembly Instructions for further information. params should be a plain JavaScript object, or a JSON string if you are using the signature option.

The auth.key Assembly parameter is required. You can also use the steps or template_id options here as described in the Transloadit documentation.

uppy.use(Transloadit, {
  params: {
    auth: { key: 'YOUR_TRANSLOADIT_KEY' },
    steps: {
      encode: {
        robot: '/video/encode',
        use: {
          steps: [':original'],
          fields: ['file_input_field2'],
        },
        preset: 'iphone',
      },
    },
  },
})

waitForEncoding: false

By default, the Transloadit plugin uploads files to Assemblies and then marks the files as complete in Uppy. The Assemblies will complete (or error) in the background but Uppy won’t know or care about it.

When waitForEncoding is set to true, the Transloadit plugin waits for Assemblies to complete before the files are marked as completed. This means users have to wait for a potentially long time, depending on how complicated your Assembly instructions are. But, you can receive transcoding results on the client side, and have a fully client-side experience this way.

When this is enabled, you can listen for the transloadit:result and transloadit:complete events.

waitForMetadata: false

By default, the Transloadit plugin uploads files to Assemblies and then marks the files as complete in Uppy. The Assemblies will complete (or error) in the background but Uppy won’t know or care about it.

When waitForMetadata is set to true, the Transloadit plugin waits for Transloadit’s backend to extract metadata from all the uploaded files. This is mostly handy if you want to have a quick user experience (so your users don’t necessarily need to wait for all the encoding to complete), but you do want to let users know about some types of errors that can be caught early on, like file format issues.

When this is enabled, you can listen for the transloadit:upload event.

importFromUploadURLs

Instead of uploading to Transloadit’s servers directly, allow another plugin to upload files, and then import those files into the Transloadit Assembly. This is set to false by default.

When enabling this option, Transloadit will not configure the Tus plugin to upload to Transloadit. Instead, a separate upload plugin must be used. Once the upload completes, the Transloadit plugin adds the uploaded file to the Assembly.

For example, to upload files to an S3 bucket and then transcode them:

uppy.use(AwsS3, {
  getUploadParameters (file) {
    return { /* upload parameters */ }
  },
})
uppy.use(Transloadit, {
  importFromUploadURLs: true,
  params: {
    auth: { key: 'YOUR_API_KEY' },
    template_id: 'YOUR_TEMPLATE_ID',
  },
})

For this to work, the upload plugin must assign a publically accessible uploadURL property to the uploaded file object. The Tus and S3 plugins both do this automatically. For the XHRUpload plugin, you may have to specify a custom getResponseData function.

alwaysRunAssembly

When set to true, always create and run an Assembly when uppy.upload() is called, even if no files were selected. This allows running Assemblies that do not receive files, but instead use a robot like /s3/import to download the files from elsewhere, for example, for a bulk transcoding job.

signature

An optional signature for the Assembly parameters. See the Transloadit documentation on Signature Authentication for further information.

If a signature is provided, params should be a JSON string instead of a JavaScript object, as otherwise the generated JSON in the browser may be different from the JSON string that was used to generate the signature.

fields

An object of form fields to send along to the Assembly. Keys are field names, and values are field values. See also the Transloadit documentation on Form Fields In Instructions.

uppy.use(Transloadit, {
  // ...
  fields: {
    message: 'This is a form field',
  },
})

You can also pass an array of field names to send global or file metadata along to the Assembly. Global metadata is set using the meta option in the Uppy constructor, or using the setMeta method. File metadata is set using the setFileMeta method. The Form plugin also sets global metadata based on the values of <input />s in the form, providing a handy way to use values from HTML form fields:

uppy.use(Form, { target: 'form#upload-form', getMetaFromForm: true })
uppy.use(Transloadit, {
  fields: ['field_name', 'other_field_name'],
  params: { /* ... */ },
})

Form fields can also be computed dynamically using custom logic, by using the getAssemblyOptions(file) option.

getAssemblyOptions(file)

While params, signature, and fields must be determined ahead of time, the getAssemblyOptions allows using dynamically generated values for these options. This way, it’s possible to use different Assembly parameters for different files, or to use some user input in an Assembly.

A custom getAssemblyOptions() option should return an object or a Promise for an object with properties { params, signature, fields }. For example, to add a field with some user-provided data from the MetaData plugin:

uppy.use(MetaData, {
  fields: [
    { id: 'caption' },
  ],
})
uppy.use(Transloadit, {
  getAssemblyOptions (file) {
    return {
      params: {
        auth: { key: 'TRANSLOADIT_AUTH_KEY_HERE' },
        template_id: 'xyz',
      },
      fields: {
        caption: file.meta.caption,
      },
    }
  },
})

Now, the ${fields.caption} variable will be available in the Assembly template.

Combine the getAssemblyOptions() option with the Form plugin to pass user input from a <form> to a Transloadit Assembly:

// This will add form field values to each file's `.meta` object:
uppy.use(Form, { getMetaFromForm: true })
uppy.use(Transloadit, {
  getAssemblyOptions (file) {
    return {
      params: { /* ... */ },
      // Pass through the fields you need:
      fields: {
        message: file.meta.message,
      },
    }
  },
})

getAssemblyOptions() may also return a Promise, so it could retrieve signed Assembly parameters from a server. For example, assuming an endpoint /transloadit-params that responds with a JSON object with { params, signature } properties:

uppy.use(Transloadit, {
  getAssemblyOptions (file) {
    return fetch('/transloadit-params').then((response) => {
      return response.json()
    })
  },
})

limit: 0

Limit the amount of uploads going on at the same time. Setting this to 0 means no limit on concurrent uploads. This option is passed through to the @uppy/tus plugin that Transloadit plugin uses internally.

locale: {}

export default {
  strings: {
    // Shown while Assemblies are being created for an upload.
    creatingAssembly: 'Preparing upload...',
    // Shown if an Assembly could not be created.
    creatingAssemblyFailed: 'Transloadit: Could not create Assembly',
    // Shown after uploads have succeeded, but when the Assembly is still executing.
    // This only shows if `waitForMetadata` or `waitForEncoding` was enabled.
    encoding: 'Encoding...',
  },
}

Errors

If an error occurs when an Assembly has already started, you can find the Assembly Status on the error object’s assembly property.

uppy.on('error', (error) => {
  if (error.assembly) {
    console.log(`Assembly ID ${error.assembly.assembly_id} failed!`)
    console.log(error.assembly)
  }
})

Events

transloadit:assembly-created

Fired when an Assembly is created.

Parameters

  • assembly - The initial Assembly Status.
  • fileIDs - The IDs of the files that will be uploaded to this Assembly.
uppy.on('transloadit:assembly-created', (assembly, fileIDs) => {
  console.group('Created', assembly.assembly_id, 'for files:')
  for (const id of fileIDs) {
    console.log(uppy.getFile(id).name)
  }
  console.groupEnd()
})

transloadit:upload

Fired when Transloadit has received an upload.

Parameters

  • file - The Transloadit file object that was uploaded.
  • assembly - The Assembly Status of the Assembly to which the file was uploaded.

transloadit:assembly-executing

Fired when Transloadit has received all uploads, and is executing the Assembly.

Parameters

transloadit:result

Fired when a result came in from an Assembly.

Parameters

  • stepName - The name of the Assembly step that generated this result.
  • result - The result object from Transloadit. This result object has one more property, namely localId. This is the ID of the file in Uppy’s local state, and can be used with uppy.getFile(id).
  • assembly - The Assembly Status of the Assembly that generated this result.
uppy.on('transloadit:result', (stepName, result) => {
  const file = uppy.getFile(result.localId)
  document.body.appendChild(html`
    <div>
      <h2>From ${file.name}</h2>
      <a href=${result.ssl_url}> View </a>
    </div>
  `)
})

transloadit:complete

Fired when an Assembly completed.

Parameters

uppy.on('transloadit:complete', (assembly) => {
  // Could do something fun with this!
  console.log(assembly.results)
})

Assembly behavior when Uppy is closed

When integrating @uppy/transloadit with @uppy/dashboard, closing the dashboard will result in continuing assemblies on the server. When the user manually cancels the upload any running assemblies will be cancelled.