@remotion/player 3.0.0-debug.11 → 3.0.0-eslint.6

package/README.md

@@ -1,8 +1,86 @@
 ### Remotion Player
 
-[![NPM Version](http://img.shields.io/npm/v/@remotion/player.svg?style=flat)](https://www.npmjs.org/package/@remotion/player)
+[![NPM Version](https://img.shields.io/npm/v/@remotion/player.svg?style=flat)](https://www.npmjs.org/package/@remotion/player)
 [![NPM Downloads](https://img.shields.io/npm/dm/@remotion/player.svg?style=flat)](https://npmcharts.com/compare/@remotion/player?minimal=true)
 [![Install Size](https://packagephobia.now.sh/badge?p=@remotion/player)](https://packagephobia.now.sh/result?p=@remotion/player)
 
-This package allows you to include a Remotion video in your React app.
-Full documentation can be found under http://remotion.dev/docs/player.
+The `@remotion/player` package allows you to embed a video powered by Remotion in a React application.
+
+## Installation and prerequisites
+
+The dependencies that Remotion requires you to have pre-installed on your machine are Node.js and FFMPEG. You can take a look at this [guide](https://github.com/adaptlearning/adapt_authoring/wiki/Installing-FFmpeg) on how to get FFMPEG on your machine.
+
+Install this package and Remotion with the package manager that you use for project:
+
+```bash
+npm i remotion @remotion/player
+```
+
+```bash
+yarn add remotion @remotion/player
+```
+
+```bash
+pnpm i remotion @remotion/player
+```
+
+> Make sure all Remotion packages you install (`remotion`, `@remotion/player`, `@remotion/gif`...) [have the same version](https://remotion.dev/docs/version-mismatch).
+
+## Getting started
+
+Now that you have this package as a dependency in your React project, it is time to see some of the basic examples that you can spin up with this package.
+
+The `@remotion/player` package can be imported as a React component from the library, which you can make use of in your components, either by nesting it in a custom component of yours or simply making it a standalone component.
+
+```javascript
+// components/MyVideo.js
+import React from 'react';
+import {useCurrentFrame} from 'remotion';
+
+const MyVideo = () => {
+	const frame = useCurrentFrame();
+
+	return (
+		<div
+			style={{
+				flex: 1,
+				textAlign: 'center',
+				fontSize: '7em',
+			}}
+		>
+			The current frame is {frame}.
+		</div>
+	);
+};
+```
+
+```javascript
+import {Player} from '@remotion/player';
+import {MyVideo} from '../components/MyVideo';
+
+export const App = () => {
+	return (
+		<Player
+			component={MyVideo}
+			durationInFrames={120}
+			compositionWidth={1920}
+			compositionHeight={1080}
+			fps={30}
+		/>
+	);
+};
+```
+
+## API
+
+The most important props accepted:
+
+| Props             | Function                                 |
+| ----------------- | ---------------------------------------- |
+| component         | A React component that renders the video |
+| durationInFrames  | The duration of the video in frames      |
+| compositionHeight | The height of the composition in pixels  |
+| compositionWidth  | The width of the composition in pixels   |
+| fps               | The frame rate of the video              |
+
+For a complete reference of the available props, refer to [@remotion/player API](https://www.remotion.dev/docs/player/api).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/player",
-	"version": "3.0.0-debug.11+551deae5b",
+	"version": "3.0.0-eslint.6+4bb89116f",
 	"description": "Remotion Player",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -14,6 +14,9 @@
 	"repository": {
 		"url": "https://github.com/remotion-dev/remotion"
 	},
+	"bugs": {
+		"url": "https://github.com/remotion-dev/remotion/issues"
+	},
 	"files": [
 		"dist",
 		"README.md"
@@ -25,7 +28,7 @@
 	],
 	"license": "SEE LICENSE IN LICENSE.md",
 	"dependencies": {
-		"remotion": "3.0.0-debug.11+551deae5b"
+		"remotion": "3.0.0-eslint.6+4bb89116f"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -49,8 +52,16 @@
 		"typescript": "^4.5.5",
 		"webpack": "5.60.0"
 	},
+	"keywords": [
+		"remotion",
+		"ffmpeg",
+		"video",
+		"react",
+		"puppeteer",
+		"player"
+	],
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "551deae5bf60be2870550eff64b2ca5f3ff03ee7"
+	"gitHead": "4bb89116fd71d0e03d92e1442a5e47b85bb3b8ae"
 }

package/dist/Freeze.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-declare type FreezeProps = {
-    frame: number;
-};
-export declare const Freeze: React.FC<FreezeProps>;
-export {};
-//# sourceMappingURL=Freeze.d.ts.map

package/dist/Freeze.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Freeze.d.ts","sourceRoot":"","sources":["../src/Freeze.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA4B,MAAM,OAAO,CAAC;AAGjD,aAAK,WAAW,GAAG;IAClB,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAcxC,CAAC"}

package/dist/Freeze.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Freeze = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const react_1 = require("react");
-const remotion_1 = require("remotion");
-const Freeze = (props) => {
-    const context = react_1.useContext(remotion_1.Internals.Timeline.TimelineContext);
-    const value = react_1.useMemo(() => {
-        return {
-            ...context,
-            frame: props.frame,
-        };
-    }, [context, props.frame]);
-    return (jsx_runtime_1.jsx(remotion_1.Internals.Timeline.TimelineContext.Provider, Object.assign({ value: value }, { children: props.children }), void 0));
-};
-exports.Freeze = Freeze;
-//# sourceMappingURL=Freeze.js.map

package/dist/Freeze.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Freeze.js","sourceRoot":"","sources":["../src/Freeze.tsx"],"names":[],"mappings":";;;;AAAA,iCAAiD;AACjD,uCAAyD;AAMlD,MAAM,MAAM,GAA0B,CAAC,KAAK,EAAE,EAAE;IACtD,MAAM,OAAO,GAAG,kBAAU,CAAC,oBAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAyB,eAAO,CAAC,GAAG,EAAE;QAChD,OAAO;YACN,GAAG,OAAO;YACV,KAAK,EAAE,KAAK,CAAC,KAAK;SAClB,CAAC;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAE3B,OAAO,CACN,kBAAC,oBAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,kBAAC,KAAK,EAAE,KAAK,gBACvD,KAAK,CAAC,QAAQ,YAC8B,CAC9C,CAAC;AACH,CAAC,CAAC;AAdW,QAAA,MAAM,UAcjB"}

package/dist/Loading.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=Loading.d.ts.map

package/dist/Loading.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Loading.d.ts","sourceRoot":"","sources":["../src/Loading.tsx"],"names":[],"mappings":""}

package/dist/Loading.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=Loading.js.map

package/dist/Loading.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Loading.js","sourceRoot":"","sources":["../src/Loading.tsx"],"names":[],"mappings":""}

package/dist/event-target-polyfill.d.ts

@@ -1,3 +0,0 @@
-declare const root: false | typeof globalThis;
-declare function isConstructor(fn: any): boolean;
-//# sourceMappingURL=event-target-polyfill.d.ts.map

package/dist/event-target-polyfill.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"event-target-polyfill.d.ts","sourceRoot":"","sources":["../src/event-target-polyfill.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,IAAI,2BAGgC,CAAC;AAE3C,iBAAS,aAAa,CAAC,EAAE,KAAA,WASxB"}

package/dist/event-target-polyfill.js

@@ -1,114 +0,0 @@
-"use strict";
-// https://raw.githubusercontent.com/benlesh/event-target-polyfill/master/index.js
-// @ts-nocheck
-const root = (typeof globalThis !== 'undefined' && globalThis) ||
-    (typeof self !== 'undefined' && self) ||
-    (typeof global !== 'undefined' && global);
-function isConstructor(fn) {
-    try {
-        // eslint-disable-next-line
-        new fn();
-    }
-    catch (error) {
-        return false;
-    }
-    return true;
-}
-if (typeof root.Event !== 'function' || !isConstructor(root.Event)) {
-    root.Event = (function () {
-        function Event(type, options) {
-            this.bubbles = Boolean(options) && Boolean(options.bubbles);
-            this.cancelable = Boolean(options) && Boolean(options.cancelable);
-            this.composed = Boolean(options) && Boolean(options.composed);
-            this.type = type;
-        }
-        return Event;
-    })();
-}
-if (typeof root.EventTarget === 'undefined' || !isConstructor(root.Event)) {
-    root.EventTarget = (function () {
-        function EventTarget() {
-            this.__listeners = new Map();
-        }
-        EventTarget.prototype = Object.create(Object.prototype);
-        EventTarget.prototype.addEventListener = function (type, listener, options) {
-            if (arguments.length < 2) {
-                throw new TypeError(`TypeError: Failed to execute 'addEventListener'
-                on 'EventTarget': 2 arguments required, but only $ {
-                    arguments.length
-                }
-                present.`);
-            }
-            const { __listeners } = this;
-            const actualType = type.toString();
-            if (!__listeners.has(actualType)) {
-                __listeners.set(actualType, new Map());
-            }
-            const listenersForType = __listeners.get(actualType);
-            if (!listenersForType.has(listener)) {
-                // Any given listener is only registered once
-                listenersForType.set(listener, options);
-            }
-        };
-        EventTarget.prototype.removeEventListener = function (type, listener) {
-            if (arguments.length < 2) {
-                throw new TypeError(`TypeError: Failed to execute 'addEventListener'
-                on 'EventTarget': 2 arguments required, but only $ {
-                    arguments.length
-                }
-                present.`);
-            }
-            const { __listeners } = this;
-            const actualType = type.toString();
-            if (__listeners.has(actualType)) {
-                const listenersForType = __listeners.get(actualType);
-                if (listenersForType.has(listener)) {
-                    listenersForType.delete(listener);
-                }
-            }
-        };
-        EventTarget.prototype.dispatchEvent = function (event) {
-            if (!(event instanceof Event)) {
-                throw new TypeError(`Failed to execute 'dispatchEvent'
-                on 'EventTarget': parameter 1 is not of type 'Event'.`);
-            }
-            const { type } = event;
-            const { __listeners } = this;
-            const listenersForType = __listeners.get(type);
-            if (listenersForType) {
-                for (const [listener, options] of listenersForType.entries()) {
-                    try {
-                        if (typeof listener === 'function') {
-                            // Listener functions must be executed with the EventTarget as the `this` context.
-                            listener.call(this, event);
-                        }
-                        else if (listener && typeof listener.handleEvent === 'function') {
-                            // Listener objects have their handleEvent method called, if they have one
-                            listener.handleEvent(event);
-                        }
-                    }
-                    catch (err) {
-                        // We need to report the error to the global error handling event,
-                        // but we do not want to break the loop that is executing the events.
-                        // Unfortunately, this is the best we can do, which isn't great, because the
-                        // native EventTarget will actually do this synchronously before moving to the next
-                        // event in the loop.
-                        setTimeout(() => {
-                            throw err;
-                        });
-                    }
-                    if (options === null || options === void 0 ? void 0 : options.once) {
-                        // If this was registered with { once: true }, we need
-                        // to remove it now.
-                        listenersForType.delete(listener);
-                    }
-                }
-            }
-            // Since there are no cancellable events on a base EventTarget,
-            // this should always return true.
-            return true;
-        };
-        return EventTarget;
-    })();
-}
-//# sourceMappingURL=event-target-polyfill.js.map

package/dist/event-target-polyfill.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"event-target-polyfill.js","sourceRoot":"","sources":["../src/event-target-polyfill.ts"],"names":[],"mappings":";AAAA,kFAAkF;AAElF,cAAc;AACd,MAAM,IAAI,GACT,CAAC,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC;IACjD,CAAC,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC;IACrC,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC;AAE3C,SAAS,aAAa,CAAC,EAAE;IACxB,IAAI;QACH,2BAA2B;QAC3B,IAAI,EAAE,EAAE,CAAC;KACT;IAAC,OAAO,KAAK,EAAE;QACf,OAAO,KAAK,CAAC;KACb;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,UAAU,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;IACnE,IAAI,CAAC,KAAK,GAAG,CAAC;QACb,SAAS,KAAK,CAAC,IAAI,EAAE,OAAO;YAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC5D,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC,CAAC,EAAE,CAAC;CACL;AAED,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,WAAW,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;IAC1E,IAAI,CAAC,WAAW,GAAG,CAAC;QACnB,SAAS,WAAW;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;QAC9B,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAExD,WAAW,CAAC,SAAS,CAAC,gBAAgB,GAAG,UACxC,IAAI,EACJ,QAAQ,EACR,OAAO;YAEP,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzB,MAAM,IAAI,SAAS,CAAC;;;;yBAIC,CAAC,CAAC;aACvB;YAED,MAAM,EAAC,WAAW,EAAC,GAAG,IAAI,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBACjC,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;aACvC;YAED,MAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACrD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBACpC,6CAA6C;gBAC7C,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aACxC;QACF,CAAC,CAAC;QAEF,WAAW,CAAC,SAAS,CAAC,mBAAmB,GAAG,UAAU,IAAI,EAAE,QAAQ;YACnE,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzB,MAAM,IAAI,SAAS,CAAC;;;;yBAIC,CAAC,CAAC;aACvB;YAED,MAAM,EAAC,WAAW,EAAC,GAAG,IAAI,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBAChC,MAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACrD,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;oBACnC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;iBAClC;aACD;QACF,CAAC,CAAC;QAEF,WAAW,CAAC,SAAS,CAAC,aAAa,GAAG,UAAU,KAAK;YACpD,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE;gBAC9B,MAAM,IAAI,SAAS,CAAC;sEAC8C,CAAC,CAAC;aACpE;YAED,MAAM,EAAC,IAAI,EAAC,GAAG,KAAK,CAAC;YACrB,MAAM,EAAC,WAAW,EAAC,GAAG,IAAI,CAAC;YAC3B,MAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,gBAAgB,EAAE;gBACrB,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,gBAAgB,CAAC,OAAO,EAAE,EAAE;oBAC7D,IAAI;wBACH,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;4BACnC,kFAAkF;4BAClF,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;yBAC3B;6BAAM,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,WAAW,KAAK,UAAU,EAAE;4BAClE,0EAA0E;4BAC1E,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;yBAC5B;qBACD;oBAAC,OAAO,GAAG,EAAE;wBACb,kEAAkE;wBAClE,qEAAqE;wBACrE,4EAA4E;wBAC5E,mFAAmF;wBACnF,qBAAqB;wBACrB,UAAU,CAAC,GAAG,EAAE;4BACf,MAAM,GAAG,CAAC;wBACX,CAAC,CAAC,CAAC;qBACH;oBAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;wBAClB,sDAAsD;wBACtD,oBAAoB;wBACpB,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;qBAClC;iBACD;aACD;YAED,+DAA+D;YAC/D,kCAAkC;YAClC,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QAEF,OAAO,WAAW,CAAC;IACpB,CAAC,CAAC,EAAE,CAAC;CACL"}