@remotion/licensing

available from v4.0.237

This package allows holders of the Company License to send events to Remotion to track the usage of renders.
Also, it offers an API to programmatically check the usage in order to implement spend controls.

How do I use this package?

Not directly - pass the licenseKey option in the renderer package you use.

Supported packages

@remotion/lambda: Pass licenseKey to renderMediaOnLambda() and renderStillOnLambda() to trigger an event.
@remotion/vercel: Pass licenseKey to renderMediaOnVercel() and renderStillOnVercel() to trigger an event.
@remotion/renderer: Pass licenseKey to renderMedia() and renderStill() to trigger an event.
@remotion/web-renderer: An event is always sent. Pass a real licenseKey, or declare eligibility for the free license with licenseKey: "free-license". See Telemetry in client-side rendering.

<details> <summary>Deprecated packages</summary>

@remotion/cloudrun: No telemetry is implemented. Use @remotion/licensing directly to track usage.
@remotion/webcodecs: Telemetry was removed in v4.0.399 because this package is no longer monetized.

</details>

On your Company License dashboard on remotion.pro, you can find your license keys on the License keys page.

Do I need to use this package?

For all versions below Remotion 5.0, it is voluntary to use this package.
An exception is @remotion/web-renderer, which will always send telemetry events.

If you are not eligible for the Free License, you need to get a Company License and are required to keep your allowance up to date.

From Remotion 5.0, telemetry reporting using the licenseKey option is mandatory for Remotion for Automators (render-based licensing).

For Remotion for Creators (seat-based licensing), telemetry reporting is optional. Remotion for Creators is meant for low-volume rendering within and for your own company, not to serve (personalized) videos to your end users.

Can I use this package to count renders if I am eligible for the Free License?

Yes, you may still create a project on remotion.pro and use this package to count renders.
You do not have to pay anything for the renders.
This package is only used to count the number of renders, not for billing.

Will I get charged based on the usage?

This package currently only counts renders, it does not bill you based on them.
If you are a Company License holder, you need to manually adjust your seat count on remotion.pro to cover all your renders.

However, the plan is to introduce a system that automatically bills you based on the usage, eliminating the need for you to manually adjust the seat count.

What data is sent?

When a telemetry event is triggered, the following information is sent to Remotion's servers:

License key
Host domain (window.location.origin) — only for @remotion/web-renderer
Event type (e.g. cloud-render, web-render)
Whether the render succeeded or failed
Whether it is a production or development render

No information about the rendered media content, metadata, or any user data is collected.

For client-side rendering using @remotion/web-renderer, the IP address is also recorded.

Telemetry data is currently retained indefinitely and is not regularly deleted.
This data is not shared with any third parties. It is only used internally by Remotion for license accountability.

Does telemetry affect renders?

No. Telemetry never blocks or fails a render. Even if the telemetry request fails or licensing is violated, the render will still complete successfully.

Can I opt out?

For versions below Remotion 5.0, you can opt out by simply not passing a licenseKey. The render will still work.

From Remotion 5.0, opt-out is possible under an Enterprise License agreement if monthly usage reports are provided instead.
The Enterprise License has the same per-render pricing, but requires a minimum spend of $500 per month.

Installation

API

import {TableOfContents} from './TableOfContents';

License

Remotion License