@remotion/player 4.0.0-alpha.4 → 4.0.0-alpha11

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 (216) hide show
  1. package/LICENSE.md +8 -8
  2. package/README.md +1 -1
  3. package/dist/cjs/MediaVolumeSlider.d.ts +5 -0
  4. package/dist/cjs/MediaVolumeSlider.js +142 -0
  5. package/dist/cjs/PlaybackrateControl.d.ts +5 -0
  6. package/dist/cjs/PlaybackrateControl.js +136 -0
  7. package/dist/cjs/Player.d.ts +52 -0
  8. package/dist/{Player.js → cjs/Player.js} +53 -83
  9. package/dist/{PlayerControls.d.ts → cjs/PlayerControls.d.ts} +18 -2
  10. package/dist/cjs/PlayerControls.js +171 -0
  11. package/dist/{PlayerSeekBar.d.ts → cjs/PlayerSeekBar.d.ts} +4 -0
  12. package/dist/{PlayerSeekBar.js → cjs/PlayerSeekBar.js} +41 -17
  13. package/dist/cjs/PlayerUI.d.ts +40 -0
  14. package/dist/{PlayerUI.js → cjs/PlayerUI.js} +115 -88
  15. package/dist/cjs/SharedPlayerContext.d.ts +15 -0
  16. package/dist/cjs/SharedPlayerContext.js +75 -0
  17. package/dist/cjs/Thumbnail.d.ts +24 -0
  18. package/dist/cjs/Thumbnail.js +46 -0
  19. package/dist/cjs/ThumbnailUI.d.ts +11 -0
  20. package/dist/cjs/ThumbnailUI.js +107 -0
  21. package/dist/{calculate-next-frame.d.ts → cjs/calculate-next-frame.d.ts} +0 -0
  22. package/dist/{calculate-next-frame.js → cjs/calculate-next-frame.js} +0 -0
  23. package/dist/cjs/calculate-scale.d.ts +39 -0
  24. package/dist/cjs/calculate-scale.js +85 -0
  25. package/dist/cjs/emitter-context.d.ts +4 -0
  26. package/dist/{emitter-context.js → cjs/emitter-context.js} +2 -1
  27. package/dist/{error-boundary.d.ts → cjs/error-boundary.d.ts} +0 -0
  28. package/dist/{error-boundary.js → cjs/error-boundary.js} +0 -0
  29. package/dist/cjs/event-emitter.d.ts +81 -0
  30. package/dist/cjs/event-emitter.js +103 -0
  31. package/dist/{format-time.d.ts → cjs/format-time.d.ts} +0 -0
  32. package/dist/{format-time.js → cjs/format-time.js} +0 -0
  33. package/dist/{icons.d.ts → cjs/icons.d.ts} +5 -1
  34. package/dist/{icons.js → cjs/icons.js} +11 -7
  35. package/dist/{index.d.ts → cjs/index.d.ts} +22 -12
  36. package/dist/cjs/index.js +25 -0
  37. package/dist/cjs/is-backgrounded.d.ts +2 -0
  38. package/dist/cjs/is-backgrounded.js +24 -0
  39. package/dist/{player-css-classname.d.ts → cjs/player-css-classname.d.ts} +0 -1
  40. package/dist/cjs/player-css-classname.js +4 -0
  41. package/dist/{player-methods.d.ts → cjs/player-methods.d.ts} +8 -4
  42. package/dist/{player-methods.js → cjs/player-methods.js} +0 -0
  43. package/dist/{test → cjs/test}/index.test.d.ts +0 -0
  44. package/dist/cjs/test/index.test.js +9 -0
  45. package/dist/{test → cjs/test}/test-utils.d.ts +0 -0
  46. package/dist/{test → cjs/test}/test-utils.js +0 -0
  47. package/dist/{test/validate-prop.test.d.ts → cjs/test/validate-in-out-frames.test.d.ts} +0 -0
  48. package/dist/cjs/test/validate-in-out-frames.test.js +56 -0
  49. package/dist/cjs/test/validate-prop.test.d.ts +1 -0
  50. package/dist/cjs/test/validate-prop.test.js +131 -0
  51. package/dist/{use-hover-state.d.ts → cjs/use-hover-state.d.ts} +0 -0
  52. package/dist/{use-hover-state.js → cjs/use-hover-state.js} +0 -0
  53. package/dist/{use-playback.d.ts → cjs/use-playback.d.ts} +0 -0
  54. package/dist/{use-playback.js → cjs/use-playback.js} +49 -9
  55. package/dist/{use-player.d.ts → cjs/use-player.d.ts} +3 -1
  56. package/dist/{use-player.js → cjs/use-player.js} +15 -8
  57. package/dist/cjs/use-thumbnail.d.ts +6 -0
  58. package/dist/cjs/use-thumbnail.js +18 -0
  59. package/dist/cjs/use-video-controls-resize.d.ts +11 -0
  60. package/dist/cjs/use-video-controls-resize.js +39 -0
  61. package/dist/{utils → cjs/utils}/calculate-player-size.d.ts +1 -1
  62. package/dist/{utils → cjs/utils}/calculate-player-size.js +9 -10
  63. package/dist/{utils → cjs/utils}/cancellable-promise.d.ts +0 -0
  64. package/dist/{utils → cjs/utils}/cancellable-promise.js +0 -0
  65. package/dist/{utils → cjs/utils}/delay.d.ts +0 -0
  66. package/dist/{utils → cjs/utils}/delay.js +0 -0
  67. package/dist/{utils → cjs/utils}/is-node.d.ts +0 -0
  68. package/dist/{utils → cjs/utils}/is-node.js +0 -0
  69. package/dist/cjs/utils/preview-size.d.ts +8 -0
  70. package/dist/{utils → cjs/utils}/preview-size.js +0 -0
  71. package/dist/cjs/utils/props-if-has-props.d.ts +10 -0
  72. package/dist/cjs/utils/props-if-has-props.js +2 -0
  73. package/dist/{utils → cjs/utils}/use-cancellable-promises.d.ts +1 -1
  74. package/dist/{utils → cjs/utils}/use-cancellable-promises.js +0 -0
  75. package/dist/{utils → cjs/utils}/use-click-prevention-on-double-click.d.ts +0 -0
  76. package/dist/{utils → cjs/utils}/use-click-prevention-on-double-click.js +5 -5
  77. package/dist/cjs/utils/use-component-visible.d.ts +6 -0
  78. package/dist/cjs/utils/use-component-visible.js +21 -0
  79. package/dist/{utils → cjs/utils}/use-element-size.d.ts +1 -0
  80. package/dist/{utils → cjs/utils}/use-element-size.js +24 -12
  81. package/dist/cjs/utils/validate-in-out-frame.d.ts +6 -0
  82. package/dist/cjs/utils/validate-in-out-frame.js +54 -0
  83. package/dist/cjs/utils/validate-initial-frame.d.ts +4 -0
  84. package/dist/cjs/utils/validate-initial-frame.js +27 -0
  85. package/dist/{utils → cjs/utils}/validate-playbackrate.d.ts +0 -0
  86. package/dist/{utils → cjs/utils}/validate-playbackrate.js +0 -0
  87. package/dist/{volume-persistance.d.ts → cjs/volume-persistance.d.ts} +0 -0
  88. package/dist/{volume-persistance.js → cjs/volume-persistance.js} +0 -0
  89. package/dist/esm/MediaVolumeSlider.d.ts +5 -0
  90. package/dist/esm/PlaybackrateControl.d.ts +5 -0
  91. package/dist/esm/Player.d.ts +52 -0
  92. package/dist/esm/PlayerControls.d.ts +41 -0
  93. package/dist/esm/PlayerSeekBar.d.ts +8 -0
  94. package/dist/esm/PlayerUI.d.ts +40 -0
  95. package/dist/esm/SharedPlayerContext.d.ts +15 -0
  96. package/dist/esm/Thumbnail.d.ts +24 -0
  97. package/dist/esm/ThumbnailUI.d.ts +11 -0
  98. package/dist/esm/calculate-next-frame.d.ts +14 -0
  99. package/dist/esm/calculate-scale.d.ts +39 -0
  100. package/dist/esm/emitter-context.d.ts +4 -0
  101. package/dist/esm/error-boundary.d.ts +19 -0
  102. package/dist/esm/event-emitter.d.ts +81 -0
  103. package/dist/esm/format-time.d.ts +1 -0
  104. package/dist/esm/icons.d.ts +13 -0
  105. package/dist/esm/index.d.ts +61 -0
  106. package/dist/esm/index.mjs +2112 -0
  107. package/dist/esm/is-backgrounded.d.ts +2 -0
  108. package/dist/esm/player-css-classname.d.ts +1 -0
  109. package/dist/esm/player-methods.d.ts +24 -0
  110. package/dist/esm/test/index.test.d.ts +1 -0
  111. package/dist/esm/test/test-utils.d.ts +6 -0
  112. package/dist/esm/test/validate-in-out-frames.test.d.ts +1 -0
  113. package/dist/esm/test/validate-prop.test.d.ts +1 -0
  114. package/dist/esm/use-hover-state.d.ts +1 -0
  115. package/dist/esm/use-playback.d.ts +7 -0
  116. package/dist/esm/use-player.d.ts +19 -0
  117. package/dist/esm/use-thumbnail.d.ts +6 -0
  118. package/dist/esm/use-video-controls-resize.d.ts +11 -0
  119. package/dist/esm/utils/calculate-player-size.d.ts +9 -0
  120. package/dist/esm/utils/cancellable-promise.d.ts +5 -0
  121. package/dist/esm/utils/delay.d.ts +1 -0
  122. package/dist/esm/utils/is-node.d.ts +1 -0
  123. package/dist/esm/utils/preview-size.d.ts +8 -0
  124. package/dist/esm/utils/props-if-has-props.d.ts +10 -0
  125. package/dist/esm/utils/use-cancellable-promises.d.ts +7 -0
  126. package/dist/esm/utils/use-click-prevention-on-double-click.d.ts +3 -0
  127. package/dist/esm/utils/use-component-visible.d.ts +5 -0
  128. package/dist/esm/utils/use-element-size.d.ts +16 -0
  129. package/dist/esm/utils/validate-in-out-frame.d.ts +6 -0
  130. package/dist/esm/utils/validate-initial-frame.d.ts +4 -0
  131. package/dist/esm/utils/validate-playbackrate.d.ts +1 -0
  132. package/dist/esm/volume-persistance.d.ts +2 -0
  133. package/dist/tsconfig-esm.tsbuildinfo +1 -0
  134. package/dist/tsconfig.tsbuildinfo +1 -0
  135. package/package.json +80 -66
  136. package/dist/MediaVolumeSlider.d.ts +0 -2
  137. package/dist/MediaVolumeSlider.d.ts.map +0 -1
  138. package/dist/MediaVolumeSlider.js +0 -93
  139. package/dist/MediaVolumeSlider.js.map +0 -1
  140. package/dist/Player.d.ts +0 -41
  141. package/dist/Player.d.ts.map +0 -1
  142. package/dist/Player.js.map +0 -1
  143. package/dist/PlayerControls.d.ts.map +0 -1
  144. package/dist/PlayerControls.js +0 -95
  145. package/dist/PlayerControls.js.map +0 -1
  146. package/dist/PlayerSeekBar.d.ts.map +0 -1
  147. package/dist/PlayerSeekBar.js.map +0 -1
  148. package/dist/PlayerUI.d.ts +0 -31
  149. package/dist/PlayerUI.d.ts.map +0 -1
  150. package/dist/PlayerUI.js.map +0 -1
  151. package/dist/calculate-next-frame.d.ts.map +0 -1
  152. package/dist/calculate-next-frame.js.map +0 -1
  153. package/dist/calculate-scale.d.ts +0 -14
  154. package/dist/calculate-scale.d.ts.map +0 -1
  155. package/dist/calculate-scale.js +0 -24
  156. package/dist/calculate-scale.js.map +0 -1
  157. package/dist/emitter-context.d.ts +0 -3
  158. package/dist/emitter-context.d.ts.map +0 -1
  159. package/dist/emitter-context.js.map +0 -1
  160. package/dist/error-boundary.d.ts.map +0 -1
  161. package/dist/error-boundary.js.map +0 -1
  162. package/dist/event-emitter.d.ts +0 -42
  163. package/dist/event-emitter.d.ts.map +0 -1
  164. package/dist/event-emitter.js +0 -55
  165. package/dist/event-emitter.js.map +0 -1
  166. package/dist/format-time.d.ts.map +0 -1
  167. package/dist/format-time.js.map +0 -1
  168. package/dist/icons.d.ts.map +0 -1
  169. package/dist/icons.js.map +0 -1
  170. package/dist/index.d.ts.map +0 -1
  171. package/dist/index.js +0 -22
  172. package/dist/index.js.map +0 -1
  173. package/dist/player-css-classname.d.ts.map +0 -1
  174. package/dist/player-css-classname.js +0 -5
  175. package/dist/player-css-classname.js.map +0 -1
  176. package/dist/player-methods.d.ts.map +0 -1
  177. package/dist/player-methods.js.map +0 -1
  178. package/dist/test/index.test.d.ts.map +0 -1
  179. package/dist/test/index.test.js +0 -8
  180. package/dist/test/index.test.js.map +0 -1
  181. package/dist/test/test-utils.d.ts.map +0 -1
  182. package/dist/test/test-utils.js.map +0 -1
  183. package/dist/test/validate-prop.test.d.ts.map +0 -1
  184. package/dist/test/validate-prop.test.js +0 -130
  185. package/dist/test/validate-prop.test.js.map +0 -1
  186. package/dist/use-hover-state.d.ts.map +0 -1
  187. package/dist/use-hover-state.js.map +0 -1
  188. package/dist/use-playback.d.ts.map +0 -1
  189. package/dist/use-playback.js.map +0 -1
  190. package/dist/use-player.d.ts.map +0 -1
  191. package/dist/use-player.js.map +0 -1
  192. package/dist/utils/browser-supports-fullscreen.d.ts +0 -12
  193. package/dist/utils/browser-supports-fullscreen.d.ts.map +0 -1
  194. package/dist/utils/browser-supports-fullscreen.js +0 -6
  195. package/dist/utils/browser-supports-fullscreen.js.map +0 -1
  196. package/dist/utils/calculate-player-size.d.ts.map +0 -1
  197. package/dist/utils/calculate-player-size.js.map +0 -1
  198. package/dist/utils/cancellable-promise.d.ts.map +0 -1
  199. package/dist/utils/cancellable-promise.js.map +0 -1
  200. package/dist/utils/delay.d.ts.map +0 -1
  201. package/dist/utils/delay.js.map +0 -1
  202. package/dist/utils/is-node.d.ts.map +0 -1
  203. package/dist/utils/is-node.js.map +0 -1
  204. package/dist/utils/preview-size.d.ts +0 -1
  205. package/dist/utils/preview-size.d.ts.map +0 -1
  206. package/dist/utils/preview-size.js.map +0 -1
  207. package/dist/utils/use-cancellable-promises.d.ts.map +0 -1
  208. package/dist/utils/use-cancellable-promises.js.map +0 -1
  209. package/dist/utils/use-click-prevention-on-double-click.d.ts.map +0 -1
  210. package/dist/utils/use-click-prevention-on-double-click.js.map +0 -1
  211. package/dist/utils/use-element-size.d.ts.map +0 -1
  212. package/dist/utils/use-element-size.js.map +0 -1
  213. package/dist/utils/validate-playbackrate.d.ts.map +0 -1
  214. package/dist/utils/validate-playbackrate.js.map +0 -1
  215. package/dist/volume-persistance.d.ts.map +0 -1
  216. package/dist/volume-persistance.js.map +0 -1
@@ -1,5 +1,5 @@
1
1
  import type { StandardLonghandProperties } from 'csstype';
2
- import type { Size } from './use-element-size';
2
+ import type { Size } from './use-element-size.js';
3
3
  export declare const calculatePlayerSize: ({ currentSize, width, height, compositionWidth, compositionHeight, }: {
4
4
  currentSize: Size | null;
5
5
  width: StandardLonghandProperties['width'] | undefined;
@@ -2,23 +2,22 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.calculatePlayerSize = void 0;
4
4
  const calculatePlayerSize = ({ currentSize, width, height, compositionWidth, compositionHeight, }) => {
5
- const aspectRatio = compositionWidth / compositionHeight;
6
- if (!currentSize) {
7
- return {
8
- width: compositionWidth,
9
- height: compositionHeight,
10
- };
11
- }
12
- // If has width specified, but no height, specify a default height that satisfies the aspect ratio.
13
5
  if (width !== undefined && height === undefined) {
14
6
  return {
15
- height: currentSize.width / aspectRatio,
7
+ aspectRatio: [compositionWidth, compositionHeight].join('/'),
16
8
  };
17
9
  }
18
10
  // Opposite: If has height specified, evaluate the height and specify a default width.
19
11
  if (height !== undefined && width === undefined) {
20
12
  return {
21
- width: currentSize.height * aspectRatio,
13
+ // Aspect ratio CSS prop will work
14
+ aspectRatio: [compositionWidth, compositionHeight].join('/'),
15
+ };
16
+ }
17
+ if (!currentSize) {
18
+ return {
19
+ width: compositionWidth,
20
+ height: compositionHeight,
22
21
  };
23
22
  }
24
23
  return {
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -0,0 +1,8 @@
1
+ export declare type Translation = {
2
+ x: number;
3
+ y: number;
4
+ };
5
+ export declare type PreviewSize = {
6
+ size: number | 'auto';
7
+ translation: Translation;
8
+ };
File without changes
@@ -0,0 +1,10 @@
1
+ import type { AnyZodObject, z } from 'zod';
2
+ export declare type PropsIfHasProps<Schema extends AnyZodObject, Props> = AnyZodObject extends Schema ? {} extends Props ? {
3
+ inputProps?: z.infer<Schema> & Props;
4
+ } : {
5
+ inputProps: Props;
6
+ } : {} extends Props ? {
7
+ inputProps: z.infer<Schema>;
8
+ } : {
9
+ inputProps: z.infer<Schema> & Props;
10
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,4 @@
1
- import type { CancellablePromise } from './cancellable-promise';
1
+ import type { CancellablePromise } from './cancellable-promise.js';
2
2
  declare const useCancellablePromises: () => {
3
3
  appendPendingPromise: (promise: CancellablePromise) => void;
4
4
  removePendingPromise: (promise: CancellablePromise) => void;
@@ -2,14 +2,14 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.useClickPreventionOnDoubleClick = void 0;
4
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");
5
+ const cancellable_promise_js_1 = require("./cancellable-promise.js");
6
+ const delay_js_1 = require("./delay.js");
7
+ const use_cancellable_promises_js_1 = require("./use-cancellable-promises.js");
8
8
  const useClickPreventionOnDoubleClick = (onClick, onDoubleClick, doubleClickToFullscreen) => {
9
- const api = (0, use_cancellable_promises_1.useCancellablePromises)();
9
+ const api = (0, use_cancellable_promises_js_1.useCancellablePromises)();
10
10
  const handleClick = (0, react_1.useCallback)(async (e) => {
11
11
  api.clearPendingPromises();
12
- const waitForClick = (0, cancellable_promise_1.cancellablePromise)((0, delay_1.delay)(200));
12
+ const waitForClick = (0, cancellable_promise_js_1.cancellablePromise)((0, delay_js_1.delay)(200));
13
13
  api.appendPendingPromise(waitForClick);
14
14
  try {
15
15
  await waitForClick.promise;
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ export default function useComponentVisible(initialIsVisible: boolean): {
3
+ ref: import("react").RefObject<HTMLDivElement>;
4
+ isComponentVisible: boolean;
5
+ setIsComponentVisible: import("react").Dispatch<import("react").SetStateAction<boolean>>;
6
+ };
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const react_1 = require("react");
4
+ // hook to hide a popup/modal when clicked outside
5
+ function useComponentVisible(initialIsVisible) {
6
+ const [isComponentVisible, setIsComponentVisible] = (0, react_1.useState)(initialIsVisible);
7
+ const ref = (0, react_1.useRef)(null);
8
+ (0, react_1.useEffect)(() => {
9
+ const handleClickOutside = (event) => {
10
+ if (ref.current && !ref.current.contains(event.target)) {
11
+ setIsComponentVisible(false);
12
+ }
13
+ };
14
+ document.addEventListener('pointerup', handleClickOutside, true);
15
+ return () => {
16
+ document.removeEventListener('pointerup', handleClickOutside, true);
17
+ };
18
+ }, []);
19
+ return { ref, isComponentVisible, setIsComponentVisible };
20
+ }
21
+ exports.default = useComponentVisible;
@@ -7,6 +7,7 @@ export declare type Size = {
7
7
  width: number;
8
8
  height: number;
9
9
  };
10
+ refresh: () => void;
10
11
  };
11
12
  export declare const updateAllElementsSizes: () => void;
12
13
  export declare const useElementSize: (ref: React.RefObject<HTMLElement>, options: {
@@ -20,11 +20,11 @@ const useElementSize = (ref, options) => {
20
20
  const { contentRect } = entries[0];
21
21
  // The clientRect returns the size with `scale()` being applied.
22
22
  const newSize = entries[0].target.getClientRects();
23
- if (!newSize || !newSize[0]) {
23
+ if (!(newSize === null || newSize === void 0 ? void 0 : newSize[0])) {
24
24
  setSize(null);
25
25
  return;
26
26
  }
27
- const probableCssParentScale = newSize[0].width / contentRect.width;
27
+ const probableCssParentScale = contentRect.width === 0 ? 1 : newSize[0].width / contentRect.width;
28
28
  const width = options.shouldApplyCssTransforms
29
29
  ? newSize[0].width
30
30
  : newSize[0].width * (1 / probableCssParentScale);
@@ -52,15 +52,27 @@ const useElementSize = (ref, options) => {
52
52
  setSize(null);
53
53
  return;
54
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
- },
55
+ setSize((prevState) => {
56
+ const isSame = prevState &&
57
+ prevState.width === rect[0].width &&
58
+ prevState.height === rect[0].height &&
59
+ prevState.left === rect[0].x &&
60
+ prevState.top === rect[0].y &&
61
+ prevState.windowSize.height === window.innerHeight &&
62
+ prevState.windowSize.width === window.innerWidth;
63
+ if (isSame) {
64
+ return prevState;
65
+ }
66
+ return {
67
+ width: rect[0].width,
68
+ height: rect[0].height,
69
+ left: rect[0].x,
70
+ top: rect[0].y,
71
+ windowSize: {
72
+ height: window.innerHeight,
73
+ width: window.innerWidth,
74
+ },
75
+ };
64
76
  });
65
77
  }, [ref]);
66
78
  (0, react_1.useEffect)(() => {
@@ -93,6 +105,6 @@ const useElementSize = (ref, options) => {
93
105
  elementSizeHooks = elementSizeHooks.filter((e) => e !== updateSize);
94
106
  };
95
107
  }, [updateSize]);
96
- return size;
108
+ return size ? { ...size, refresh: updateSize } : null;
97
109
  };
98
110
  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,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,5 @@
1
+ import React from 'react';
2
+ export declare const Checkmark: () => JSX.Element;
3
+ export declare const PlaybackrateControl: React.FC<{
4
+ playbackRates: number[];
5
+ }>;
@@ -0,0 +1,52 @@
1
+ import type { ComponentType } from 'react';
2
+ import React from 'react';
3
+ import type { CompProps } from 'remotion';
4
+ import type { AnyZodObject } from 'zod';
5
+ import type { PlayerRef } from './player-methods.js';
6
+ import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
7
+ import type { RenderLoading, RenderPoster } from './PlayerUI.js';
8
+ import type { PropsIfHasProps } from './utils/props-if-has-props.js';
9
+ export declare type ErrorFallback = (info: {
10
+ error: Error;
11
+ }) => React.ReactNode;
12
+ export declare type PlayerProps<Schema extends AnyZodObject, Props> = {
13
+ durationInFrames: number;
14
+ compositionWidth: number;
15
+ compositionHeight: number;
16
+ fps: number;
17
+ showVolumeControls?: boolean;
18
+ controls?: boolean;
19
+ errorFallback?: ErrorFallback;
20
+ style?: React.CSSProperties;
21
+ loop?: boolean;
22
+ autoPlay?: boolean;
23
+ allowFullscreen?: boolean;
24
+ clickToPlay?: boolean;
25
+ doubleClickToFullscreen?: boolean;
26
+ spaceKeyToPlayOrPause?: boolean;
27
+ numberOfSharedAudioTags?: number;
28
+ playbackRate?: number;
29
+ renderLoading?: RenderLoading;
30
+ moveToBeginningWhenEnded?: boolean;
31
+ className?: string;
32
+ initialFrame?: number;
33
+ renderPoster?: RenderPoster;
34
+ showPosterWhenPaused?: boolean;
35
+ showPosterWhenEnded?: boolean;
36
+ showPosterWhenUnplayed?: boolean;
37
+ inFrame?: number | null;
38
+ outFrame?: number | null;
39
+ initiallyShowControls?: number | boolean;
40
+ renderPlayPauseButton?: RenderPlayPauseButton;
41
+ renderFullscreenButton?: RenderFullscreenButton;
42
+ alwaysShowControls?: boolean;
43
+ schema?: Schema;
44
+ initiallyMuted?: boolean;
45
+ showPlaybackRateControl?: boolean | number[];
46
+ } & CompProps<Props> & PropsIfHasProps<Schema, Props>;
47
+ export declare const componentOrNullIfLazy: <Props>(props: CompProps<Props>) => ComponentType<Props> | null;
48
+ /**
49
+ * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a Remotion video.
50
+ * @see [Documentation](https://www.remotion.dev/docs/player/player)
51
+ */
52
+ export declare const Player: <Schema extends AnyZodObject, Props>(props: PlayerProps<Schema, Props> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;
@@ -0,0 +1,41 @@
1
+ import type { MouseEventHandler, ReactNode } from 'react';
2
+ import React from 'react';
3
+ import type { usePlayer } from './use-player.js';
4
+ export declare type RenderPlayPauseButton = (props: {
5
+ playing: boolean;
6
+ }) => ReactNode;
7
+ export declare type RenderFullscreenButton = (props: {
8
+ isFullscreen: boolean;
9
+ }) => ReactNode;
10
+ declare global {
11
+ interface Document {
12
+ webkitFullscreenEnabled?: boolean;
13
+ webkitFullscreenElement?: Element;
14
+ webkitExitFullscreen?: Document['exitFullscreen'];
15
+ }
16
+ interface HTMLDivElement {
17
+ webkitRequestFullScreen: HTMLDivElement['requestFullscreen'];
18
+ }
19
+ }
20
+ export declare const Controls: React.FC<{
21
+ fps: number;
22
+ durationInFrames: number;
23
+ hovered: boolean;
24
+ showVolumeControls: boolean;
25
+ player: ReturnType<typeof usePlayer>;
26
+ onFullscreenButtonClick: MouseEventHandler<HTMLButtonElement>;
27
+ isFullscreen: boolean;
28
+ allowFullscreen: boolean;
29
+ onExitFullscreenButtonClick: MouseEventHandler<HTMLButtonElement>;
30
+ spaceKeyToPlayOrPause: boolean;
31
+ onSeekEnd: () => void;
32
+ onSeekStart: () => void;
33
+ inFrame: number | null;
34
+ outFrame: number | null;
35
+ initiallyShowControls: number | boolean;
36
+ playerWidth: number;
37
+ renderPlayPauseButton: RenderPlayPauseButton | null;
38
+ renderFullscreenButton: RenderFullscreenButton | null;
39
+ alwaysShowControls: boolean;
40
+ showPlaybackRateControl: boolean | number[];
41
+ }>;
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ export declare const PlayerSeekBar: React.FC<{
3
+ durationInFrames: number;
4
+ onSeekStart: () => void;
5
+ onSeekEnd: () => void;
6
+ inFrame: number | null;
7
+ outFrame: number | null;
8
+ }>;
@@ -0,0 +1,40 @@
1
+ import React from 'react';
2
+ import type { PlayerRef } from './player-methods.js';
3
+ import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
4
+ export declare type ErrorFallback = (info: {
5
+ error: Error;
6
+ }) => React.ReactNode;
7
+ export declare type RenderLoading = (canvas: {
8
+ height: number;
9
+ width: number;
10
+ }) => React.ReactNode;
11
+ export declare type RenderPoster = RenderLoading;
12
+ declare const _default: React.ForwardRefExoticComponent<{
13
+ controls: boolean;
14
+ loop: boolean;
15
+ autoPlay: boolean;
16
+ allowFullscreen: boolean;
17
+ inputProps: Record<string, unknown>;
18
+ showVolumeControls: boolean;
19
+ style?: React.CSSProperties | undefined;
20
+ clickToPlay: boolean;
21
+ doubleClickToFullscreen: boolean;
22
+ spaceKeyToPlayOrPause: boolean;
23
+ errorFallback: ErrorFallback;
24
+ playbackRate: number;
25
+ renderLoading: RenderLoading | undefined;
26
+ renderPoster: RenderLoading | undefined;
27
+ className: string | undefined;
28
+ moveToBeginningWhenEnded: boolean;
29
+ showPosterWhenPaused: boolean;
30
+ showPosterWhenEnded: boolean;
31
+ showPosterWhenUnplayed: boolean;
32
+ inFrame: number | null;
33
+ outFrame: number | null;
34
+ initiallyShowControls: number | boolean;
35
+ renderPlayPauseButton: RenderPlayPauseButton | null;
36
+ renderFullscreen: RenderFullscreenButton | null;
37
+ alwaysShowControls: boolean;
38
+ showPlaybackRateControl: boolean | number[];
39
+ } & React.RefAttributes<PlayerRef>>;
40
+ export default _default;
@@ -0,0 +1,15 @@
1
+ import type { ComponentType, LazyExoticComponent } from 'react';
2
+ import React from 'react';
3
+ import type { TimelineContextValue } from 'remotion';
4
+ export declare const SharedPlayerContexts: React.FC<{
5
+ children: React.ReactNode;
6
+ timelineContext: TimelineContextValue;
7
+ inputProps?: Record<string, unknown>;
8
+ fps: number;
9
+ compositionWidth: number;
10
+ compositionHeight: number;
11
+ durationInFrames: number;
12
+ component: LazyExoticComponent<ComponentType<unknown>>;
13
+ numberOfSharedAudioTags: number;
14
+ initiallyMuted: boolean;
15
+ }>;
@@ -0,0 +1,24 @@
1
+ import type { CSSProperties, MutableRefObject } from 'react';
2
+ import type { CompProps } from 'remotion';
3
+ import type { AnyZodObject } from 'zod';
4
+ import type { ThumbnailMethods } from './player-methods.js';
5
+ import type { ErrorFallback, RenderLoading } from './PlayerUI.js';
6
+ import type { PropsIfHasProps } from './utils/props-if-has-props.js';
7
+ declare type ThumbnailProps<Schema extends AnyZodObject, Props> = PropsIfHasProps<Schema, Props> & CompProps<Schema> & {
8
+ frameToDisplay: number;
9
+ style?: CSSProperties;
10
+ durationInFrames: number;
11
+ compositionWidth: number;
12
+ compositionHeight: number;
13
+ fps: number;
14
+ errorFallback?: ErrorFallback;
15
+ renderLoading?: RenderLoading;
16
+ className?: string;
17
+ };
18
+ export declare const ThumbnailFn: <Schema extends AnyZodObject, Props>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<Schema, Props>, ref: MutableRefObject<ThumbnailMethods>) => JSX.Element;
19
+ /**
20
+ * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a single frame of a video.
21
+ * @see [Documentation](https://www.remotion.dev/docs/player/thumbnail)
22
+ */
23
+ export declare const Thumbnail: <Schema extends AnyZodObject, Props>(props: ThumbnailProps<Schema, Props> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
24
+ export {};
@@ -0,0 +1,11 @@
1
+ import React from 'react';
2
+ import type { ThumbnailMethods } from './player-methods.js';
3
+ import type { ErrorFallback, RenderLoading } from './PlayerUI.js';
4
+ declare const _default: React.ForwardRefExoticComponent<{
5
+ inputProps: Record<string, unknown>;
6
+ style?: React.CSSProperties | undefined;
7
+ errorFallback: ErrorFallback;
8
+ renderLoading: RenderLoading | undefined;
9
+ className: string | undefined;
10
+ } & React.RefAttributes<ThumbnailMethods>>;
11
+ export default _default;
@@ -0,0 +1,14 @@
1
+ export declare const calculateNextFrame: ({ time, currentFrame: startFrame, playbackSpeed, fps, actualLastFrame, actualFirstFrame, framesAdvanced, shouldLoop, }: {
2
+ time: number;
3
+ currentFrame: number;
4
+ playbackSpeed: number;
5
+ fps: number;
6
+ actualFirstFrame: number;
7
+ actualLastFrame: number;
8
+ framesAdvanced: number;
9
+ shouldLoop: boolean;
10
+ }) => {
11
+ nextFrame: number;
12
+ framesToAdvance: number;
13
+ hasEnded: boolean;
14
+ };
@@ -0,0 +1,39 @@
1
+ import type { VideoConfig } from 'remotion';
2
+ import type { PreviewSize } from './utils/preview-size.js';
3
+ import type { Size } from './utils/use-element-size.js';
4
+ export declare const calculateScale: ({ canvasSize, compositionHeight, compositionWidth, previewSize, }: {
5
+ previewSize: PreviewSize['size'];
6
+ compositionWidth: number;
7
+ compositionHeight: number;
8
+ canvasSize: Size;
9
+ }) => number;
10
+ declare type Layout = {
11
+ centerX: number;
12
+ centerY: number;
13
+ xCorrection: number;
14
+ yCorrection: number;
15
+ scale: number;
16
+ };
17
+ export declare const calculateCanvasTransformation: ({ previewSize, compositionWidth, compositionHeight, canvasSize, }: {
18
+ previewSize: PreviewSize['size'];
19
+ compositionWidth: number;
20
+ compositionHeight: number;
21
+ canvasSize: Size;
22
+ }) => Layout;
23
+ export declare const calculateOuterStyle: ({ config, style, canvasSize, }: {
24
+ config: VideoConfig | null;
25
+ style: React.CSSProperties | undefined;
26
+ canvasSize: Size | null;
27
+ }) => React.CSSProperties;
28
+ export declare const calculateContainerStyle: ({ config, canvasSize, layout, scale, }: {
29
+ config: VideoConfig | null;
30
+ canvasSize: Size | null;
31
+ layout: Layout | null;
32
+ scale: number;
33
+ }) => React.CSSProperties;
34
+ export declare const calculateOuter: ({ layout, scale, config, }: {
35
+ layout: Layout | null;
36
+ scale: number;
37
+ config: VideoConfig | null;
38
+ }) => React.CSSProperties;
39
+ export {};
@@ -0,0 +1,4 @@
1
+ import React from 'react';
2
+ import type { PlayerEmitter, ThumbnailEmitter } from './event-emitter.js';
3
+ export declare const PlayerEventEmitterContext: React.Context<PlayerEmitter | undefined>;
4
+ export declare const ThumbnailEmitterContext: React.Context<ThumbnailEmitter | undefined>;
@@ -0,0 +1,19 @@
1
+ import React from 'react';
2
+ export declare class ErrorBoundary extends React.Component<{
3
+ onError: (error: Error) => void;
4
+ children: React.ReactNode;
5
+ errorFallback: (info: {
6
+ error: Error;
7
+ }) => React.ReactNode;
8
+ }, {
9
+ hasError: Error | null;
10
+ }> {
11
+ state: {
12
+ hasError: null;
13
+ };
14
+ static getDerivedStateFromError(error: Error): {
15
+ hasError: Error;
16
+ };
17
+ componentDidCatch(error: Error): void;
18
+ render(): string | number | boolean | React.ReactFragment | JSX.Element | null | undefined;
19
+ }