Skip to main content

Zoom

The @uppy/zoom plugin lets users import files from their Zoom account.

tip

Try out the live example or take it for a spin in CodeSandbox.

When should I use this?​

When you want to let users import files from their Zoom account.

A Companion instance is required for the Zoom plugin to work. Companion handles authentication with Zoom, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

You can self-host Companion or get a hosted version with any Transloadit plan.

npm install @uppy/zoom

Use​

Using Zoom requires setup in both Uppy and Companion.

Use in Uppy​

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Zoom from '@uppy/zoom';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Zoom, {
	target: Dashboard,
	companionUrl: 'https://your-companion.com',
});

Use in Companion​

Configure the Zoom key and secret. With the standalone Companion server, specify environment variables:

export COMPANION_ZOOM_KEY="Zoom API key"
export COMPANION_ZOOM_SECRET="Zoom API secret"

When using the Companion Node.js API, configure these options:

companion.app({
	providerOptions: {
		zoom: {
			key: 'Zoom API key',
			secret: 'Zoom API secret',
		},
	},
});

API​

Options​

id​

A unique identifier for this plugin (string, default: 'Zoom').

title​

Title / name shown in the UI, such as Dashboard tabs (string, default: 'Zoom').

target​

DOM element, CSS selector, or plugin to place the drag and drop area into (string or Element, default: null).

companionUrl​

URL to a Companion instance (string, default: null).

companionHeaders​

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts​

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array, default: companionUrl).

This value can be a string, a RegExp pattern, or an Array of both. This is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine.

companionCookiesRule​

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale​

export default {
	strings: {
		pluginNameZoom: 'Zoom',
	},
};