@remotion/player 3.3.36 → 3.3.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/dist/cjs/MediaVolumeSlider.d.ts +5 -0
  2. package/dist/cjs/MediaVolumeSlider.js +118 -0
  3. package/dist/cjs/Player.d.ts +43 -0
  4. package/dist/cjs/Player.js +143 -0
  5. package/dist/cjs/PlayerControls.d.ts +41 -0
  6. package/dist/cjs/PlayerControls.js +152 -0
  7. package/dist/cjs/PlayerSeekBar.d.ts +8 -0
  8. package/dist/cjs/PlayerSeekBar.js +146 -0
  9. package/dist/cjs/PlayerUI.d.ts +38 -0
  10. package/dist/cjs/PlayerUI.js +308 -0
  11. package/dist/cjs/SharedPlayerContext.d.ts +14 -0
  12. package/dist/cjs/SharedPlayerContext.js +72 -0
  13. package/dist/cjs/Thumbnail.d.ts +20 -0
  14. package/dist/cjs/Thumbnail.js +42 -0
  15. package/dist/cjs/ThumbnailUI.d.ts +11 -0
  16. package/dist/cjs/ThumbnailUI.js +107 -0
  17. package/dist/cjs/calculate-next-frame.d.ts +14 -0
  18. package/dist/cjs/calculate-next-frame.js +28 -0
  19. package/dist/cjs/calculate-scale.d.ts +39 -0
  20. package/dist/cjs/calculate-scale.js +85 -0
  21. package/dist/cjs/emitter-context.d.ts +4 -0
  22. package/dist/cjs/emitter-context.js +9 -0
  23. package/dist/cjs/error-boundary.d.ts +19 -0
  24. package/dist/cjs/error-boundary.js +39 -0
  25. package/dist/cjs/event-emitter.d.ts +66 -0
  26. package/dist/cjs/event-emitter.js +87 -0
  27. package/dist/cjs/format-time.d.ts +1 -0
  28. package/dist/cjs/format-time.js +9 -0
  29. package/dist/cjs/icons.d.ts +10 -0
  30. package/dist/cjs/icons.js +50 -0
  31. package/dist/cjs/index.d.ts +61 -0
  32. package/dist/cjs/index.js +25 -0
  33. package/dist/cjs/player-css-classname.d.ts +1 -0
  34. package/dist/cjs/player-css-classname.js +4 -0
  35. package/dist/cjs/player-methods.d.ts +24 -0
  36. package/dist/cjs/player-methods.js +2 -0
  37. package/dist/cjs/test/index.test.d.ts +1 -0
  38. package/dist/cjs/test/index.test.js +9 -0
  39. package/dist/cjs/test/test-utils.d.ts +6 -0
  40. package/dist/cjs/test/test-utils.js +32 -0
  41. package/dist/cjs/test/validate-in-out-frames.test.d.ts +1 -0
  42. package/dist/cjs/test/validate-in-out-frames.test.js +56 -0
  43. package/dist/cjs/test/validate-prop.test.d.ts +1 -0
  44. package/dist/cjs/test/validate-prop.test.js +131 -0
  45. package/dist/cjs/use-hover-state.d.ts +1 -0
  46. package/dist/cjs/use-hover-state.js +27 -0
  47. package/dist/cjs/use-playback.d.ts +7 -0
  48. package/dist/cjs/use-playback.js +92 -0
  49. package/dist/cjs/use-player.d.ts +19 -0
  50. package/dist/cjs/use-player.js +132 -0
  51. package/dist/cjs/use-thumbnail.d.ts +6 -0
  52. package/dist/cjs/use-thumbnail.js +18 -0
  53. package/dist/cjs/use-video-controls-resize.d.ts +7 -0
  54. package/dist/cjs/use-video-controls-resize.js +36 -0
  55. package/dist/cjs/utils/calculate-player-size.d.ts +9 -0
  56. package/dist/cjs/utils/calculate-player-size.js +29 -0
  57. package/dist/cjs/utils/cancellable-promise.d.ts +5 -0
  58. package/dist/cjs/utils/cancellable-promise.js +26 -0
  59. package/dist/cjs/utils/delay.d.ts +1 -0
  60. package/dist/cjs/utils/delay.js +6 -0
  61. package/dist/cjs/utils/is-node.d.ts +1 -0
  62. package/dist/cjs/utils/is-node.js +4 -0
  63. package/dist/cjs/utils/preview-size.d.ts +8 -0
  64. package/dist/cjs/utils/preview-size.js +2 -0
  65. package/dist/cjs/utils/props-if-has-props.d.ts +5 -0
  66. package/dist/cjs/utils/props-if-has-props.js +2 -0
  67. package/dist/cjs/utils/use-cancellable-promises.d.ts +7 -0
  68. package/dist/cjs/utils/use-cancellable-promises.js +21 -0
  69. package/dist/cjs/utils/use-click-prevention-on-double-click.d.ts +3 -0
  70. package/dist/cjs/utils/use-click-prevention-on-double-click.js +45 -0
  71. package/dist/cjs/utils/use-element-size.d.ts +16 -0
  72. package/dist/cjs/utils/use-element-size.js +98 -0
  73. package/dist/cjs/utils/validate-in-out-frame.d.ts +6 -0
  74. package/dist/cjs/utils/validate-in-out-frame.js +54 -0
  75. package/dist/cjs/utils/validate-initial-frame.d.ts +4 -0
  76. package/dist/cjs/utils/validate-initial-frame.js +27 -0
  77. package/dist/cjs/utils/validate-playbackrate.d.ts +1 -0
  78. package/dist/cjs/utils/validate-playbackrate.js +18 -0
  79. package/dist/cjs/volume-persistance.d.ts +2 -0
  80. package/dist/cjs/volume-persistance.js +19 -0
  81. package/dist/esm/MediaVolumeSlider.d.ts +5 -0
  82. package/dist/esm/MediaVolumeSlider.js +114 -0
  83. package/dist/esm/Player.d.ts +43 -0
  84. package/dist/esm/Player.js +136 -0
  85. package/dist/esm/PlayerControls.d.ts +41 -0
  86. package/dist/esm/PlayerControls.js +148 -0
  87. package/dist/esm/PlayerSeekBar.d.ts +8 -0
  88. package/dist/esm/PlayerSeekBar.js +142 -0
  89. package/dist/esm/PlayerUI.d.ts +38 -0
  90. package/dist/esm/PlayerUI.js +283 -0
  91. package/dist/esm/SharedPlayerContext.d.ts +14 -0
  92. package/dist/esm/SharedPlayerContext.js +68 -0
  93. package/dist/esm/Thumbnail.d.ts +20 -0
  94. package/dist/esm/Thumbnail.js +35 -0
  95. package/dist/esm/ThumbnailUI.d.ts +11 -0
  96. package/dist/esm/ThumbnailUI.js +82 -0
  97. package/dist/esm/calculate-next-frame.d.ts +14 -0
  98. package/dist/esm/calculate-next-frame.js +24 -0
  99. package/dist/esm/calculate-scale.d.ts +39 -0
  100. package/dist/esm/calculate-scale.js +77 -0
  101. package/dist/esm/emitter-context.d.ts +4 -0
  102. package/dist/esm/emitter-context.js +3 -0
  103. package/dist/esm/error-boundary.d.ts +19 -0
  104. package/dist/esm/error-boundary.js +32 -0
  105. package/dist/esm/event-emitter.d.ts +66 -0
  106. package/dist/esm/event-emitter.js +82 -0
  107. package/dist/esm/format-time.d.ts +1 -0
  108. package/dist/esm/format-time.js +5 -0
  109. package/dist/esm/icons.d.ts +10 -0
  110. package/dist/esm/icons.js +42 -0
  111. package/dist/esm/index.d.ts +61 -0
  112. package/dist/esm/index.js +20 -0
  113. package/dist/esm/player-css-classname.d.ts +1 -0
  114. package/dist/esm/player-css-classname.js +1 -0
  115. package/dist/esm/player-methods.d.ts +24 -0
  116. package/dist/esm/player-methods.js +1 -0
  117. package/dist/esm/test/index.test.d.ts +1 -0
  118. package/dist/esm/test/index.test.js +7 -0
  119. package/dist/esm/test/test-utils.d.ts +6 -0
  120. package/dist/esm/test/test-utils.js +14 -0
  121. package/dist/esm/test/validate-in-out-frames.test.d.ts +1 -0
  122. package/dist/esm/test/validate-in-out-frames.test.js +54 -0
  123. package/dist/esm/test/validate-prop.test.d.ts +1 -0
  124. package/dist/esm/test/validate-prop.test.js +129 -0
  125. package/dist/esm/use-hover-state.d.ts +1 -0
  126. package/dist/esm/use-hover-state.js +23 -0
  127. package/dist/esm/use-playback.d.ts +7 -0
  128. package/dist/esm/use-playback.js +88 -0
  129. package/dist/esm/use-player.d.ts +19 -0
  130. package/dist/esm/use-player.js +128 -0
  131. package/dist/esm/use-thumbnail.d.ts +6 -0
  132. package/dist/esm/use-thumbnail.js +14 -0
  133. package/dist/esm/use-video-controls-resize.d.ts +7 -0
  134. package/dist/esm/use-video-controls-resize.js +32 -0
  135. package/dist/esm/utils/calculate-player-size.d.ts +9 -0
  136. package/dist/esm/utils/calculate-player-size.js +25 -0
  137. package/dist/esm/utils/cancellable-promise.d.ts +5 -0
  138. package/dist/esm/utils/cancellable-promise.js +22 -0
  139. package/dist/esm/utils/delay.d.ts +1 -0
  140. package/dist/esm/utils/delay.js +2 -0
  141. package/dist/esm/utils/is-node.d.ts +1 -0
  142. package/dist/esm/utils/is-node.js +1 -0
  143. package/dist/esm/utils/preview-size.d.ts +8 -0
  144. package/dist/esm/utils/preview-size.js +1 -0
  145. package/dist/esm/utils/props-if-has-props.d.ts +5 -0
  146. package/dist/esm/utils/props-if-has-props.js +1 -0
  147. package/dist/esm/utils/use-cancellable-promises.d.ts +7 -0
  148. package/dist/esm/utils/use-cancellable-promises.js +18 -0
  149. package/dist/esm/utils/use-click-prevention-on-double-click.d.ts +3 -0
  150. package/dist/esm/utils/use-click-prevention-on-double-click.js +42 -0
  151. package/dist/esm/utils/use-element-size.d.ts +16 -0
  152. package/dist/esm/utils/use-element-size.js +93 -0
  153. package/dist/esm/utils/validate-in-out-frame.d.ts +6 -0
  154. package/dist/esm/utils/validate-in-out-frame.js +49 -0
  155. package/dist/esm/utils/validate-initial-frame.d.ts +4 -0
  156. package/dist/esm/utils/validate-initial-frame.js +23 -0
  157. package/dist/esm/utils/validate-playbackrate.d.ts +1 -0
  158. package/dist/esm/utils/validate-playbackrate.js +14 -0
  159. package/dist/esm/volume-persistance.d.ts +2 -0
  160. package/dist/esm/volume-persistance.js +14 -0
  161. package/dist/tsconfig-cjs.tsbuildinfo +1 -0
  162. package/dist/tsconfig.tsbuildinfo +1 -0
  163. package/package.json +17 -6
@@ -0,0 +1,7 @@
1
+ import type { CancellablePromise } from './cancellable-promise';
2
+ declare const useCancellablePromises: () => {
3
+ appendPendingPromise: (promise: CancellablePromise) => void;
4
+ removePendingPromise: (promise: CancellablePromise) => void;
5
+ clearPendingPromises: () => void[];
6
+ };
7
+ export { useCancellablePromises };
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useCancellablePromises = void 0;
4
+ const react_1 = require("react");
5
+ const useCancellablePromises = () => {
6
+ const pendingPromises = (0, react_1.useRef)([]);
7
+ const appendPendingPromise = (0, react_1.useCallback)((promise) => {
8
+ pendingPromises.current = [...pendingPromises.current, promise];
9
+ }, []);
10
+ const removePendingPromise = (0, react_1.useCallback)((promise) => {
11
+ pendingPromises.current = pendingPromises.current.filter((p) => p !== promise);
12
+ }, []);
13
+ const clearPendingPromises = (0, react_1.useCallback)(() => pendingPromises.current.map((p) => p.cancel()), []);
14
+ const api = (0, react_1.useMemo)(() => ({
15
+ appendPendingPromise,
16
+ removePendingPromise,
17
+ clearPendingPromises,
18
+ }), [appendPendingPromise, clearPendingPromises, removePendingPromise]);
19
+ return api;
20
+ };
21
+ exports.useCancellablePromises = useCancellablePromises;
@@ -0,0 +1,3 @@
1
+ import type { SyntheticEvent } from 'react';
2
+ declare const useClickPreventionOnDoubleClick: (onClick: (e: SyntheticEvent) => void, onDoubleClick: () => void, doubleClickToFullscreen: boolean) => [(e: SyntheticEvent) => void, () => void];
3
+ export { useClickPreventionOnDoubleClick };
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useClickPreventionOnDoubleClick = void 0;
4
+ const react_1 = require("react");
5
+ const cancellable_promise_1 = require("./cancellable-promise");
6
+ const delay_1 = require("./delay");
7
+ const use_cancellable_promises_1 = require("./use-cancellable-promises");
8
+ const useClickPreventionOnDoubleClick = (onClick, onDoubleClick, doubleClickToFullscreen) => {
9
+ const api = (0, use_cancellable_promises_1.useCancellablePromises)();
10
+ const handleClick = (0, react_1.useCallback)(async (e) => {
11
+ api.clearPendingPromises();
12
+ const waitForClick = (0, cancellable_promise_1.cancellablePromise)((0, delay_1.delay)(200));
13
+ api.appendPendingPromise(waitForClick);
14
+ try {
15
+ await waitForClick.promise;
16
+ api.removePendingPromise(waitForClick);
17
+ onClick(e);
18
+ }
19
+ catch (errorInfo) {
20
+ const info = errorInfo;
21
+ api.removePendingPromise(waitForClick);
22
+ if (!info.isCanceled) {
23
+ throw info.error;
24
+ }
25
+ }
26
+ }, [api, onClick]);
27
+ const handleDoubleClick = (0, react_1.useCallback)(() => {
28
+ api.clearPendingPromises();
29
+ onDoubleClick();
30
+ }, [api, onDoubleClick]);
31
+ const returnValue = (0, react_1.useMemo)(() => {
32
+ if (!doubleClickToFullscreen) {
33
+ return [onClick, onDoubleClick];
34
+ }
35
+ return [handleClick, handleDoubleClick];
36
+ }, [
37
+ doubleClickToFullscreen,
38
+ handleClick,
39
+ handleDoubleClick,
40
+ onClick,
41
+ onDoubleClick,
42
+ ]);
43
+ return returnValue;
44
+ };
45
+ exports.useClickPreventionOnDoubleClick = useClickPreventionOnDoubleClick;
@@ -0,0 +1,16 @@
1
+ export declare type Size = {
2
+ width: number;
3
+ height: number;
4
+ left: number;
5
+ top: number;
6
+ windowSize: {
7
+ width: number;
8
+ height: number;
9
+ };
10
+ refresh: () => void;
11
+ };
12
+ export declare const updateAllElementsSizes: () => void;
13
+ export declare const useElementSize: (ref: React.RefObject<HTMLElement>, options: {
14
+ triggerOnWindowResize: boolean;
15
+ shouldApplyCssTransforms: boolean;
16
+ }) => Size | null;
@@ -0,0 +1,98 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useElementSize = exports.updateAllElementsSizes = void 0;
4
+ const react_1 = require("react");
5
+ let elementSizeHooks = [];
6
+ const updateAllElementsSizes = () => {
7
+ for (const listener of elementSizeHooks) {
8
+ listener();
9
+ }
10
+ };
11
+ exports.updateAllElementsSizes = updateAllElementsSizes;
12
+ const useElementSize = (ref, options) => {
13
+ const [size, setSize] = (0, react_1.useState)(null);
14
+ const observer = (0, react_1.useMemo)(() => {
15
+ if (typeof ResizeObserver === 'undefined') {
16
+ return null;
17
+ }
18
+ return new ResizeObserver((entries) => {
19
+ // The contentRect returns the width without any `scale()`'s being applied. The height is wrong
20
+ const { contentRect } = entries[0];
21
+ // The clientRect returns the size with `scale()` being applied.
22
+ const newSize = entries[0].target.getClientRects();
23
+ if (!newSize || !newSize[0]) {
24
+ setSize(null);
25
+ return;
26
+ }
27
+ const probableCssParentScale = newSize[0].width / contentRect.width;
28
+ const width = options.shouldApplyCssTransforms
29
+ ? newSize[0].width
30
+ : newSize[0].width * (1 / probableCssParentScale);
31
+ const height = options.shouldApplyCssTransforms
32
+ ? newSize[0].height
33
+ : newSize[0].height * (1 / probableCssParentScale);
34
+ setSize({
35
+ width,
36
+ height,
37
+ left: newSize[0].x,
38
+ top: newSize[0].y,
39
+ windowSize: {
40
+ height: window.innerHeight,
41
+ width: window.innerWidth,
42
+ },
43
+ });
44
+ });
45
+ }, [options.shouldApplyCssTransforms]);
46
+ const updateSize = (0, react_1.useCallback)(() => {
47
+ if (!ref.current) {
48
+ return;
49
+ }
50
+ const rect = ref.current.getClientRects();
51
+ if (!rect[0]) {
52
+ setSize(null);
53
+ return;
54
+ }
55
+ setSize({
56
+ width: rect[0].width,
57
+ height: rect[0].height,
58
+ left: rect[0].x,
59
+ top: rect[0].y,
60
+ windowSize: {
61
+ height: window.innerHeight,
62
+ width: window.innerWidth,
63
+ },
64
+ });
65
+ }, [ref]);
66
+ (0, react_1.useEffect)(() => {
67
+ if (!observer) {
68
+ return;
69
+ }
70
+ updateSize();
71
+ const { current } = ref;
72
+ if (ref.current) {
73
+ observer.observe(ref.current);
74
+ }
75
+ return () => {
76
+ if (current) {
77
+ observer.unobserve(current);
78
+ }
79
+ };
80
+ }, [observer, ref, updateSize]);
81
+ (0, react_1.useEffect)(() => {
82
+ if (!options.triggerOnWindowResize) {
83
+ return;
84
+ }
85
+ window.addEventListener('resize', updateSize);
86
+ return () => {
87
+ window.removeEventListener('resize', updateSize);
88
+ };
89
+ }, [options.triggerOnWindowResize, updateSize]);
90
+ (0, react_1.useEffect)(() => {
91
+ elementSizeHooks.push(updateSize);
92
+ return () => {
93
+ elementSizeHooks = elementSizeHooks.filter((e) => e !== updateSize);
94
+ };
95
+ }, [updateSize]);
96
+ return size ? { ...size, refresh: updateSize } : null;
97
+ };
98
+ exports.useElementSize = useElementSize;
@@ -0,0 +1,6 @@
1
+ export declare const validateSingleFrame: (frame: unknown, variableName: string) => number | null;
2
+ export declare const validateInOutFrames: ({ inFrame, durationInFrames, outFrame, }: {
3
+ inFrame: unknown;
4
+ outFrame: unknown;
5
+ durationInFrames: number;
6
+ }) => void;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateInOutFrames = exports.validateSingleFrame = void 0;
4
+ const validateSingleFrame = (frame, variableName) => {
5
+ if (typeof frame === 'undefined' || frame === null) {
6
+ return frame !== null && frame !== void 0 ? frame : null;
7
+ }
8
+ if (typeof frame !== 'number') {
9
+ throw new TypeError(`"${variableName}" must be a number, but is ${JSON.stringify(frame)}`);
10
+ }
11
+ if (Number.isNaN(frame)) {
12
+ throw new TypeError(`"${variableName}" must not be NaN, but is ${JSON.stringify(frame)}`);
13
+ }
14
+ if (!Number.isFinite(frame)) {
15
+ throw new TypeError(`"${variableName}" must be finite, but is ${JSON.stringify(frame)}`);
16
+ }
17
+ if (frame % 1 !== 0) {
18
+ throw new TypeError(`"${variableName}" must be an integer, but is ${JSON.stringify(frame)}`);
19
+ }
20
+ return frame;
21
+ };
22
+ exports.validateSingleFrame = validateSingleFrame;
23
+ const validateInOutFrames = ({ inFrame, durationInFrames, outFrame, }) => {
24
+ const validatedInFrame = (0, exports.validateSingleFrame)(inFrame, 'inFrame');
25
+ const validatedOutFrame = (0, exports.validateSingleFrame)(outFrame, 'outFrame');
26
+ if (validatedInFrame === null && validatedOutFrame === null) {
27
+ return;
28
+ }
29
+ // Must not be over the duration
30
+ if (validatedInFrame !== null && validatedInFrame > durationInFrames - 1) {
31
+ throw new Error('inFrame must be less than (durationInFrames - 1), but is ' +
32
+ validatedInFrame);
33
+ }
34
+ if (validatedOutFrame !== null && validatedOutFrame > durationInFrames - 1) {
35
+ throw new Error('outFrame must be less than (durationInFrames - 1), but is ' +
36
+ validatedOutFrame);
37
+ }
38
+ // Must not be under 0
39
+ if (validatedInFrame !== null && validatedInFrame < 0) {
40
+ throw new Error('inFrame must be greater than 0, but is ' + validatedInFrame);
41
+ }
42
+ if (validatedOutFrame !== null && validatedOutFrame <= 0) {
43
+ throw new Error(`outFrame must be greater than 0, but is ${validatedOutFrame}. If you want to render a single frame, use <Thumbnail /> instead.`);
44
+ }
45
+ if (validatedOutFrame !== null &&
46
+ validatedInFrame !== null &&
47
+ validatedOutFrame <= validatedInFrame) {
48
+ throw new Error('outFrame must be greater than inFrame, but is ' +
49
+ validatedOutFrame +
50
+ ' <= ' +
51
+ validatedInFrame);
52
+ }
53
+ };
54
+ exports.validateInOutFrames = validateInOutFrames;
@@ -0,0 +1,4 @@
1
+ export declare const validateInitialFrame: ({ initialFrame, durationInFrames, }: {
2
+ initialFrame: unknown;
3
+ durationInFrames: unknown;
4
+ }) => void;
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateInitialFrame = void 0;
4
+ const validateInitialFrame = ({ initialFrame, durationInFrames, }) => {
5
+ if (typeof durationInFrames !== 'number') {
6
+ throw new Error(`\`durationInFrames\` must be a number, but is ${JSON.stringify(durationInFrames)}`);
7
+ }
8
+ if (typeof initialFrame === 'undefined') {
9
+ return;
10
+ }
11
+ if (typeof initialFrame !== 'number') {
12
+ throw new Error(`\`initialFrame\` must be a number, but is ${JSON.stringify(initialFrame)}`);
13
+ }
14
+ if (Number.isNaN(initialFrame)) {
15
+ throw new Error(`\`initialFrame\` must be a number, but is NaN`);
16
+ }
17
+ if (!Number.isFinite(initialFrame)) {
18
+ throw new Error(`\`initialFrame\` must be a number, but is Infinity`);
19
+ }
20
+ if (initialFrame % 1 !== 0) {
21
+ throw new Error(`\`initialFrame\` must be an integer, but is ${JSON.stringify(initialFrame)}`);
22
+ }
23
+ if (initialFrame > durationInFrames - 1) {
24
+ throw new Error(`\`initialFrame\` must be less or equal than \`durationInFrames - 1\`, but is ${JSON.stringify(initialFrame)}`);
25
+ }
26
+ };
27
+ exports.validateInitialFrame = validateInitialFrame;
@@ -0,0 +1 @@
1
+ export declare const validatePlaybackRate: (playbackRate: number | undefined) => void;
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validatePlaybackRate = void 0;
4
+ const validatePlaybackRate = (playbackRate) => {
5
+ if (playbackRate === undefined) {
6
+ return;
7
+ }
8
+ if (playbackRate > 4) {
9
+ throw new Error(`The highest possible playback rate is 4. You passed: ${playbackRate}`);
10
+ }
11
+ if (playbackRate < -4) {
12
+ throw new Error(`The lowest possible playback rate is -4. You passed: ${playbackRate}`);
13
+ }
14
+ if (playbackRate === 0) {
15
+ throw new Error(`A playback rate of 0 is not supported.`);
16
+ }
17
+ };
18
+ exports.validatePlaybackRate = validatePlaybackRate;
@@ -0,0 +1,2 @@
1
+ export declare const persistVolume: (volume: number) => void;
2
+ export declare const getPreferredVolume: () => number;
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getPreferredVolume = exports.persistVolume = void 0;
4
+ const VOLUME_PERSISTANCE_KEY = 'remotion.volumePreference';
5
+ const persistVolume = (volume) => {
6
+ if (typeof window === 'undefined') {
7
+ return;
8
+ }
9
+ window.localStorage.setItem(VOLUME_PERSISTANCE_KEY, String(volume));
10
+ };
11
+ exports.persistVolume = persistVolume;
12
+ const getPreferredVolume = () => {
13
+ if (typeof window === 'undefined') {
14
+ return 1;
15
+ }
16
+ const val = window.localStorage.getItem(VOLUME_PERSISTANCE_KEY);
17
+ return val ? Number(val) : 1;
18
+ };
19
+ exports.getPreferredVolume = getPreferredVolume;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ export declare const VOLUME_SLIDER_WIDTH = 100;
3
+ export declare const MediaVolumeSlider: React.FC<{
4
+ displayVerticalVolumeSlider: Boolean;
5
+ }>;
@@ -0,0 +1,114 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { useCallback, useId, useMemo, useRef, useState } from 'react';
3
+ import { Internals, random } from 'remotion';
4
+ import { ICON_SIZE, VolumeOffIcon, VolumeOnIcon } from './icons';
5
+ import { useHoverState } from './use-hover-state';
6
+ const BAR_HEIGHT = 5;
7
+ const KNOB_SIZE = 12;
8
+ export const VOLUME_SLIDER_WIDTH = 100;
9
+ export const MediaVolumeSlider = ({ displayVerticalVolumeSlider }) => {
10
+ const [mediaMuted, setMediaMuted] = Internals.useMediaMutedState();
11
+ const [mediaVolume, setMediaVolume] = Internals.useMediaVolumeState();
12
+ const [focused, setFocused] = useState(false);
13
+ const parentDivRef = useRef(null);
14
+ const inputRef = useRef(null);
15
+ const hover = useHoverState(parentDivRef);
16
+ // eslint-disable-next-line react-hooks/rules-of-hooks
17
+ const randomId = typeof useId === 'undefined' ? 'volume-slider' : useId();
18
+ const [randomClass] = useState(() => `__remotion-volume-slider-${random(randomId)}`.replace('.', ''));
19
+ const isMutedOrZero = mediaMuted || mediaVolume === 0;
20
+ const onVolumeChange = (e) => {
21
+ setMediaVolume(parseFloat(e.target.value));
22
+ };
23
+ const onBlur = () => {
24
+ setTimeout(() => {
25
+ // We need a small delay to check which element was focused next,
26
+ // and if it wasn't the volume slider, we hide it
27
+ if (document.activeElement !== inputRef.current) {
28
+ setFocused(false);
29
+ }
30
+ }, 10);
31
+ };
32
+ const onClick = useCallback(() => {
33
+ if (mediaVolume === 0) {
34
+ setMediaVolume(1);
35
+ setMediaMuted(false);
36
+ return;
37
+ }
38
+ setMediaMuted((mute) => !mute);
39
+ }, [mediaVolume, setMediaMuted, setMediaVolume]);
40
+ const parentDivStyle = useMemo(() => {
41
+ return {
42
+ display: 'inline-flex',
43
+ background: 'none',
44
+ border: 'none',
45
+ padding: '6px',
46
+ justifyContent: 'center',
47
+ alignItems: 'center',
48
+ touchAction: 'none',
49
+ ...(displayVerticalVolumeSlider && { position: 'relative' }),
50
+ };
51
+ }, [displayVerticalVolumeSlider]);
52
+ const volumeContainer = useMemo(() => {
53
+ return {
54
+ display: 'inline',
55
+ width: ICON_SIZE,
56
+ height: ICON_SIZE,
57
+ cursor: 'pointer',
58
+ appearance: 'none',
59
+ background: 'none',
60
+ border: 'none',
61
+ padding: 0,
62
+ };
63
+ }, []);
64
+ const inputStyle = useMemo(() => {
65
+ const commonStyle = {
66
+ WebkitAppearance: 'none',
67
+ backgroundColor: 'rgba(255, 255, 255, 0.5)',
68
+ borderRadius: BAR_HEIGHT / 2,
69
+ cursor: 'pointer',
70
+ height: BAR_HEIGHT,
71
+ width: VOLUME_SLIDER_WIDTH,
72
+ backgroundImage: `linear-gradient(
73
+ to right,
74
+ white ${mediaVolume * 100}%, rgba(255, 255, 255, 0) ${mediaVolume * 100}%
75
+ )`,
76
+ };
77
+ if (displayVerticalVolumeSlider) {
78
+ return {
79
+ ...commonStyle,
80
+ transform: `rotate(-90deg)`,
81
+ position: 'absolute',
82
+ bottom: ICON_SIZE + VOLUME_SLIDER_WIDTH / 2 + 5,
83
+ };
84
+ }
85
+ return {
86
+ ...commonStyle,
87
+ marginLeft: 5,
88
+ };
89
+ }, [displayVerticalVolumeSlider, mediaVolume]);
90
+ const sliderStyle = `
91
+ .${randomClass}::-webkit-slider-thumb {
92
+ -webkit-appearance: none;
93
+ background-color: white;
94
+ border-radius: ${KNOB_SIZE / 2}px;
95
+ box-shadow: 0 0 2px black;
96
+ height: ${KNOB_SIZE}px;
97
+ width: ${KNOB_SIZE}px;
98
+ }
99
+
100
+ .${randomClass}::-moz-range-thumb {
101
+ -webkit-appearance: none;
102
+ background-color: white;
103
+ border-radius: ${KNOB_SIZE / 2}px;
104
+ box-shadow: 0 0 2px black;
105
+ height: ${KNOB_SIZE}px;
106
+ width: ${KNOB_SIZE}px;
107
+ }
108
+ `;
109
+ return (_jsxs("div", { ref: parentDivRef, style: parentDivStyle, children: [_jsx("style", {
110
+ // eslint-disable-next-line react/no-danger
111
+ dangerouslySetInnerHTML: {
112
+ __html: sliderStyle,
113
+ } }), _jsx("button", { "aria-label": isMutedOrZero ? 'Unmute sound' : 'Mute sound', title: isMutedOrZero ? 'Unmute sound' : 'Mute sound', onClick: onClick, onBlur: onBlur, onFocus: () => setFocused(true), style: volumeContainer, type: "button", children: isMutedOrZero ? _jsx(VolumeOffIcon, {}) : _jsx(VolumeOnIcon, {}) }), (focused || hover) && !mediaMuted ? (_jsx("input", { ref: inputRef, "aria-label": "Change volume", className: randomClass, max: 1, min: 0, onBlur: () => setFocused(false), onChange: onVolumeChange, step: 0.01, type: "range", value: mediaVolume, style: inputStyle })) : null] }));
114
+ };
@@ -0,0 +1,43 @@
1
+ import type { ComponentType } from 'react';
2
+ import React from 'react';
3
+ import type { CompProps } from 'remotion';
4
+ import type { PlayerRef } from './player-methods';
5
+ import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls';
6
+ import type { RenderLoading, RenderPoster } from './PlayerUI';
7
+ import type { PropsIfHasProps } from './utils/props-if-has-props';
8
+ export declare type ErrorFallback = (info: {
9
+ error: Error;
10
+ }) => React.ReactNode;
11
+ export declare type PlayerProps<T> = {
12
+ durationInFrames: number;
13
+ compositionWidth: number;
14
+ compositionHeight: number;
15
+ fps: number;
16
+ showVolumeControls?: boolean;
17
+ controls?: boolean;
18
+ errorFallback?: ErrorFallback;
19
+ style?: React.CSSProperties;
20
+ loop?: boolean;
21
+ autoPlay?: boolean;
22
+ allowFullscreen?: boolean;
23
+ clickToPlay?: boolean;
24
+ doubleClickToFullscreen?: boolean;
25
+ spaceKeyToPlayOrPause?: boolean;
26
+ numberOfSharedAudioTags?: number;
27
+ playbackRate?: number;
28
+ renderLoading?: RenderLoading;
29
+ moveToBeginningWhenEnded?: boolean;
30
+ className?: string;
31
+ initialFrame?: number;
32
+ renderPoster?: RenderPoster;
33
+ showPosterWhenPaused?: boolean;
34
+ showPosterWhenEnded?: boolean;
35
+ showPosterWhenUnplayed?: boolean;
36
+ inFrame?: number | null;
37
+ outFrame?: number | null;
38
+ initiallyShowControls?: number | boolean;
39
+ renderPlayPauseButton?: RenderPlayPauseButton;
40
+ renderFullscreenButton?: RenderFullscreenButton;
41
+ } & PropsIfHasProps<T> & CompProps<T>;
42
+ export declare const componentOrNullIfLazy: <T>(props: CompProps<T>) => ComponentType<T> | null;
43
+ export declare const Player: <T>(props: PlayerProps<T> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;
@@ -0,0 +1,136 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { forwardRef, useEffect, useImperativeHandle, useLayoutEffect, useMemo, useRef, useState, } from 'react';
3
+ import { Composition, Internals } from 'remotion';
4
+ import { PlayerEventEmitterContext } from './emitter-context';
5
+ import { PlayerEmitter } from './event-emitter';
6
+ import { PLAYER_CSS_CLASSNAME } from './player-css-classname';
7
+ import PlayerUI from './PlayerUI';
8
+ import { SharedPlayerContexts } from './SharedPlayerContext';
9
+ import { validateInOutFrames } from './utils/validate-in-out-frame';
10
+ import { validateInitialFrame } from './utils/validate-initial-frame';
11
+ import { validatePlaybackRate } from './utils/validate-playbackrate';
12
+ export const componentOrNullIfLazy = (props) => {
13
+ if ('component' in props) {
14
+ return props.component;
15
+ }
16
+ return null;
17
+ };
18
+ const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps, inputProps, style, controls = false, loop = false, autoPlay = false, showVolumeControls = true, allowFullscreen = true, clickToPlay, doubleClickToFullscreen = false, spaceKeyToPlayOrPause = true, moveToBeginningWhenEnded = true, numberOfSharedAudioTags = 5, errorFallback = () => '⚠️', playbackRate = 1, renderLoading, className, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, initialFrame, renderPoster, inFrame, outFrame, initiallyShowControls, renderFullscreenButton, renderPlayPauseButton, ...componentProps }, ref) => {
19
+ if (typeof window !== 'undefined') {
20
+ // eslint-disable-next-line react-hooks/rules-of-hooks
21
+ useLayoutEffect(() => {
22
+ window.remotion_isPlayer = true;
23
+ }, []);
24
+ }
25
+ // @ts-expect-error
26
+ if (componentProps.defaultProps !== undefined) {
27
+ throw new Error('The <Player /> component does not accept `defaultProps`, but some were passed. Use `inputProps` instead.');
28
+ }
29
+ const componentForValidation = componentOrNullIfLazy(componentProps);
30
+ // @ts-expect-error
31
+ if ((componentForValidation === null || componentForValidation === void 0 ? void 0 : componentForValidation.type) === Composition) {
32
+ throw new TypeError(`'component' should not be an instance of <Composition/>. Pass the React component directly, and set the duration, fps and dimensions as separate props. See https://www.remotion.dev/docs/player/examples for an example.`);
33
+ }
34
+ if (componentForValidation === Composition) {
35
+ throw new TypeError(`'component' must not be the 'Composition' component. Pass your own React component directly, and set the duration, fps and dimensions as separate props. See https://www.remotion.dev/docs/player/examples for an example.`);
36
+ }
37
+ const component = Internals.useLazyComponent(componentProps);
38
+ validateInitialFrame({ initialFrame, durationInFrames });
39
+ const [frame, setFrame] = useState(() => initialFrame !== null && initialFrame !== void 0 ? initialFrame : 0);
40
+ const [playing, setPlaying] = useState(false);
41
+ const [rootId] = useState('player-comp');
42
+ const [emitter] = useState(() => new PlayerEmitter());
43
+ const rootRef = useRef(null);
44
+ const audioAndVideoTags = useRef([]);
45
+ const imperativePlaying = useRef(false);
46
+ if (typeof compositionHeight !== 'number') {
47
+ throw new TypeError(`'compositionHeight' must be a number but got '${typeof compositionHeight}' instead`);
48
+ }
49
+ if (typeof compositionWidth !== 'number') {
50
+ throw new TypeError(`'compositionWidth' must be a number but got '${typeof compositionWidth}' instead`);
51
+ }
52
+ Internals.validateDimension(compositionHeight, 'compositionHeight', 'of the <Player /> component');
53
+ Internals.validateDimension(compositionWidth, 'compositionWidth', 'of the <Player /> component');
54
+ Internals.validateDurationInFrames(durationInFrames, 'of the <Player/> component');
55
+ Internals.validateFps(fps, 'as a prop of the <Player/> component', false);
56
+ validateInOutFrames({
57
+ durationInFrames,
58
+ inFrame,
59
+ outFrame,
60
+ });
61
+ if (typeof controls !== 'boolean' && typeof controls !== 'undefined') {
62
+ throw new TypeError(`'controls' must be a boolean or undefined but got '${typeof controls}' instead`);
63
+ }
64
+ if (typeof autoPlay !== 'boolean' && typeof autoPlay !== 'undefined') {
65
+ throw new TypeError(`'autoPlay' must be a boolean or undefined but got '${typeof autoPlay}' instead`);
66
+ }
67
+ if (typeof loop !== 'boolean' && typeof loop !== 'undefined') {
68
+ throw new TypeError(`'loop' must be a boolean or undefined but got '${typeof loop}' instead`);
69
+ }
70
+ if (typeof doubleClickToFullscreen !== 'boolean' &&
71
+ typeof doubleClickToFullscreen !== 'undefined') {
72
+ throw new TypeError(`'doubleClickToFullscreen' must be a boolean or undefined but got '${typeof doubleClickToFullscreen}' instead`);
73
+ }
74
+ if (typeof showVolumeControls !== 'boolean' &&
75
+ typeof showVolumeControls !== 'undefined') {
76
+ throw new TypeError(`'showVolumeControls' must be a boolean or undefined but got '${typeof showVolumeControls}' instead`);
77
+ }
78
+ if (typeof allowFullscreen !== 'boolean' &&
79
+ typeof allowFullscreen !== 'undefined') {
80
+ throw new TypeError(`'allowFullscreen' must be a boolean or undefined but got '${typeof allowFullscreen}' instead`);
81
+ }
82
+ if (typeof clickToPlay !== 'boolean' && typeof clickToPlay !== 'undefined') {
83
+ throw new TypeError(`'clickToPlay' must be a boolean or undefined but got '${typeof clickToPlay}' instead`);
84
+ }
85
+ if (typeof spaceKeyToPlayOrPause !== 'boolean' &&
86
+ typeof spaceKeyToPlayOrPause !== 'undefined') {
87
+ throw new TypeError(`'spaceKeyToPlayOrPause' must be a boolean or undefined but got '${typeof spaceKeyToPlayOrPause}' instead`);
88
+ }
89
+ if (typeof numberOfSharedAudioTags !== 'number' ||
90
+ numberOfSharedAudioTags % 1 !== 0 ||
91
+ !Number.isFinite(numberOfSharedAudioTags) ||
92
+ Number.isNaN(numberOfSharedAudioTags) ||
93
+ numberOfSharedAudioTags < 0) {
94
+ throw new TypeError(`'numberOfSharedAudioTags' must be an integer but got '${numberOfSharedAudioTags}' instead`);
95
+ }
96
+ validatePlaybackRate(playbackRate);
97
+ useEffect(() => {
98
+ emitter.dispatchRatechange(playbackRate);
99
+ }, [emitter, playbackRate]);
100
+ useImperativeHandle(ref, () => rootRef.current, []);
101
+ const timelineContextValue = useMemo(() => {
102
+ return {
103
+ frame,
104
+ playing,
105
+ rootId,
106
+ shouldRegisterSequences: false,
107
+ playbackRate,
108
+ imperativePlaying,
109
+ setPlaybackRate: () => {
110
+ throw new Error('playback rate');
111
+ },
112
+ audioAndVideoTags,
113
+ };
114
+ }, [frame, playbackRate, playing, rootId]);
115
+ const setTimelineContextValue = useMemo(() => {
116
+ return {
117
+ setFrame,
118
+ setPlaying,
119
+ };
120
+ }, [setFrame]);
121
+ const passedInputProps = useMemo(() => {
122
+ return inputProps !== null && inputProps !== void 0 ? inputProps : {};
123
+ }, [inputProps]);
124
+ if (typeof window !== 'undefined') {
125
+ // eslint-disable-next-line react-hooks/rules-of-hooks
126
+ useLayoutEffect(() => {
127
+ // Inject CSS only on client, and also only after the Player has hydrated
128
+ Internals.CSSUtils.injectCSS(Internals.CSSUtils.makeDefaultCSS(`.${PLAYER_CSS_CLASSNAME}`, '#fff'));
129
+ }, []);
130
+ }
131
+ return (_jsx(Internals.IsPlayerContextProvider, { children: _jsx(SharedPlayerContexts, { timelineContext: timelineContextValue, component: component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: numberOfSharedAudioTags, children: _jsx(Internals.Timeline.SetTimelineContext.Provider, { value: setTimelineContextValue, children: _jsx(PlayerEventEmitterContext.Provider, { value: emitter, children: _jsx(PlayerUI, { ref: rootRef, renderLoading: renderLoading, autoPlay: Boolean(autoPlay), loop: Boolean(loop), controls: Boolean(controls), errorFallback: errorFallback, style: style, inputProps: passedInputProps, allowFullscreen: Boolean(allowFullscreen), moveToBeginningWhenEnded: Boolean(moveToBeginningWhenEnded), clickToPlay: typeof clickToPlay === 'boolean'
132
+ ? clickToPlay
133
+ : Boolean(controls), showVolumeControls: Boolean(showVolumeControls), doubleClickToFullscreen: Boolean(doubleClickToFullscreen), spaceKeyToPlayOrPause: Boolean(spaceKeyToPlayOrPause), playbackRate: playbackRate, className: className !== null && className !== void 0 ? className : undefined, showPosterWhenUnplayed: Boolean(showPosterWhenUnplayed), showPosterWhenEnded: Boolean(showPosterWhenEnded), showPosterWhenPaused: Boolean(showPosterWhenPaused), renderPoster: renderPoster, inFrame: inFrame !== null && inFrame !== void 0 ? inFrame : null, outFrame: outFrame !== null && outFrame !== void 0 ? outFrame : null, initiallyShowControls: initiallyShowControls !== null && initiallyShowControls !== void 0 ? initiallyShowControls : true, renderFullscreen: renderFullscreenButton !== null && renderFullscreenButton !== void 0 ? renderFullscreenButton : null, renderPlayPauseButton: renderPlayPauseButton !== null && renderPlayPauseButton !== void 0 ? renderPlayPauseButton : null }) }) }) }) }));
134
+ };
135
+ const forward = forwardRef;
136
+ export const Player = forward(PlayerFn);