@remotion/player 3.3.36 → 3.3.37

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/{MediaVolumeSlider.d.ts → cjs/MediaVolumeSlider.d.ts} +0 -0
  2. package/dist/{MediaVolumeSlider.js → cjs/MediaVolumeSlider.js} +0 -0
  3. package/dist/{Player.d.ts → cjs/Player.d.ts} +0 -0
  4. package/dist/{Player.js → cjs/Player.js} +3 -1
  5. package/dist/{PlayerControls.d.ts → cjs/PlayerControls.d.ts} +0 -0
  6. package/dist/{PlayerControls.js → cjs/PlayerControls.js} +16 -2
  7. package/dist/{PlayerSeekBar.d.ts → cjs/PlayerSeekBar.d.ts} +0 -0
  8. package/dist/{PlayerSeekBar.js → cjs/PlayerSeekBar.js} +0 -0
  9. package/dist/{PlayerUI.d.ts → cjs/PlayerUI.d.ts} +0 -0
  10. package/dist/{PlayerUI.js → cjs/PlayerUI.js} +0 -0
  11. package/dist/{SharedPlayerContext.d.ts → cjs/SharedPlayerContext.d.ts} +0 -0
  12. package/dist/{SharedPlayerContext.js → cjs/SharedPlayerContext.js} +0 -0
  13. package/dist/{Thumbnail.d.ts → cjs/Thumbnail.d.ts} +0 -0
  14. package/dist/{Thumbnail.js → cjs/Thumbnail.js} +1 -1
  15. package/dist/{ThumbnailUI.d.ts → cjs/ThumbnailUI.d.ts} +0 -0
  16. package/dist/{ThumbnailUI.js → cjs/ThumbnailUI.js} +0 -0
  17. package/dist/{calculate-next-frame.d.ts → cjs/calculate-next-frame.d.ts} +0 -0
  18. package/dist/{calculate-next-frame.js → cjs/calculate-next-frame.js} +0 -0
  19. package/dist/{calculate-scale.d.ts → cjs/calculate-scale.d.ts} +0 -0
  20. package/dist/{calculate-scale.js → cjs/calculate-scale.js} +0 -0
  21. package/dist/{emitter-context.d.ts → cjs/emitter-context.d.ts} +0 -0
  22. package/dist/{emitter-context.js → cjs/emitter-context.js} +0 -0
  23. package/dist/{error-boundary.d.ts → cjs/error-boundary.d.ts} +0 -0
  24. package/dist/{error-boundary.js → cjs/error-boundary.js} +0 -0
  25. package/dist/{event-emitter.d.ts → cjs/event-emitter.d.ts} +0 -0
  26. package/dist/{event-emitter.js → cjs/event-emitter.js} +0 -0
  27. package/dist/{format-time.d.ts → cjs/format-time.d.ts} +0 -0
  28. package/dist/{format-time.js → cjs/format-time.js} +0 -0
  29. package/dist/{icons.d.ts → cjs/icons.d.ts} +0 -0
  30. package/dist/{icons.js → cjs/icons.js} +0 -0
  31. package/dist/{index.d.ts → cjs/index.d.ts} +0 -0
  32. package/dist/{index.js → cjs/index.js} +0 -0
  33. package/dist/{player-css-classname.d.ts → cjs/player-css-classname.d.ts} +0 -0
  34. package/dist/{player-css-classname.js → cjs/player-css-classname.js} +0 -0
  35. package/dist/{player-methods.d.ts → cjs/player-methods.d.ts} +0 -0
  36. package/dist/{player-methods.js → cjs/player-methods.js} +0 -0
  37. package/dist/{test → cjs/test}/index.test.d.ts +0 -0
  38. package/dist/{test → cjs/test}/index.test.js +0 -0
  39. package/dist/{test → cjs/test}/test-utils.d.ts +0 -0
  40. package/dist/{test → cjs/test}/test-utils.js +0 -0
  41. package/dist/{test → cjs/test}/validate-in-out-frames.test.d.ts +0 -0
  42. package/dist/{test → cjs/test}/validate-in-out-frames.test.js +0 -0
  43. package/dist/{test → cjs/test}/validate-prop.test.d.ts +0 -0
  44. package/dist/{test → cjs/test}/validate-prop.test.js +0 -0
  45. package/dist/{use-hover-state.d.ts → cjs/use-hover-state.d.ts} +0 -0
  46. package/dist/{use-hover-state.js → cjs/use-hover-state.js} +0 -0
  47. package/dist/{use-playback.d.ts → cjs/use-playback.d.ts} +0 -0
  48. package/dist/{use-playback.js → cjs/use-playback.js} +0 -0
  49. package/dist/{use-player.d.ts → cjs/use-player.d.ts} +0 -0
  50. package/dist/{use-player.js → cjs/use-player.js} +0 -0
  51. package/dist/{use-thumbnail.d.ts → cjs/use-thumbnail.d.ts} +0 -0
  52. package/dist/{use-thumbnail.js → cjs/use-thumbnail.js} +0 -0
  53. package/dist/{use-video-controls-resize.d.ts → cjs/use-video-controls-resize.d.ts} +0 -0
  54. package/dist/{use-video-controls-resize.js → cjs/use-video-controls-resize.js} +0 -0
  55. package/dist/{utils → cjs/utils}/calculate-player-size.d.ts +0 -0
  56. package/dist/{utils → cjs/utils}/calculate-player-size.js +0 -0
  57. package/dist/{utils → cjs/utils}/cancellable-promise.d.ts +0 -0
  58. package/dist/{utils → cjs/utils}/cancellable-promise.js +0 -0
  59. package/dist/{utils → cjs/utils}/delay.d.ts +0 -0
  60. package/dist/{utils → cjs/utils}/delay.js +0 -0
  61. package/dist/{utils → cjs/utils}/is-node.d.ts +0 -0
  62. package/dist/{utils → cjs/utils}/is-node.js +0 -0
  63. package/dist/{utils → cjs/utils}/preview-size.d.ts +0 -0
  64. package/dist/{utils → cjs/utils}/preview-size.js +0 -0
  65. package/dist/{utils → cjs/utils}/props-if-has-props.d.ts +0 -0
  66. package/dist/{utils → cjs/utils}/props-if-has-props.js +0 -0
  67. package/dist/{utils → cjs/utils}/use-cancellable-promises.d.ts +0 -0
  68. package/dist/{utils → cjs/utils}/use-cancellable-promises.js +0 -0
  69. package/dist/{utils → cjs/utils}/use-click-prevention-on-double-click.d.ts +0 -0
  70. package/dist/{utils → cjs/utils}/use-click-prevention-on-double-click.js +0 -0
  71. package/dist/{utils → cjs/utils}/use-element-size.d.ts +1 -0
  72. package/dist/{utils → cjs/utils}/use-element-size.js +1 -1
  73. package/dist/{utils → cjs/utils}/validate-in-out-frame.d.ts +0 -0
  74. package/dist/{utils → cjs/utils}/validate-in-out-frame.js +0 -0
  75. package/dist/{utils → cjs/utils}/validate-initial-frame.d.ts +0 -0
  76. package/dist/{utils → cjs/utils}/validate-initial-frame.js +0 -0
  77. package/dist/{utils → cjs/utils}/validate-playbackrate.d.ts +0 -0
  78. package/dist/{utils → cjs/utils}/validate-playbackrate.js +0 -0
  79. package/dist/{volume-persistance.d.ts → cjs/volume-persistance.d.ts} +0 -0
  80. package/dist/{volume-persistance.js → cjs/volume-persistance.js} +0 -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
File without changes
@@ -135,7 +135,9 @@ const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps,
135
135
  remotion_1.Internals.CSSUtils.injectCSS(remotion_1.Internals.CSSUtils.makeDefaultCSS(`.${player_css_classname_1.PLAYER_CSS_CLASSNAME}`, '#fff'));
136
136
  }, []);
137
137
  }
138
- return ((0, jsx_runtime_1.jsx)(SharedPlayerContext_1.SharedPlayerContexts, { timelineContext: timelineContextValue, component: component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: numberOfSharedAudioTags, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.Timeline.SetTimelineContext.Provider, { value: setTimelineContextValue, children: (0, jsx_runtime_1.jsx)(emitter_context_1.PlayerEventEmitterContext.Provider, { value: emitter, children: (0, jsx_runtime_1.jsx)(PlayerUI_1.default, { 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' ? clickToPlay : 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 }) }) }) }));
138
+ return ((0, jsx_runtime_1.jsx)(remotion_1.Internals.IsPlayerContextProvider, { children: (0, jsx_runtime_1.jsx)(SharedPlayerContext_1.SharedPlayerContexts, { timelineContext: timelineContextValue, component: component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: numberOfSharedAudioTags, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.Timeline.SetTimelineContext.Provider, { value: setTimelineContextValue, children: (0, jsx_runtime_1.jsx)(emitter_context_1.PlayerEventEmitterContext.Provider, { value: emitter, children: (0, jsx_runtime_1.jsx)(PlayerUI_1.default, { 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'
139
+ ? clickToPlay
140
+ : 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 }) }) }) }) }));
139
141
  };
140
142
  const forward = react_1.forwardRef;
141
143
  exports.Player = forward(PlayerFn);
@@ -11,14 +11,28 @@ const PlayerSeekBar_1 = require("./PlayerSeekBar");
11
11
  const use_video_controls_resize_1 = require("./use-video-controls-resize");
12
12
  exports.X_SPACER = 10;
13
13
  exports.X_PADDING = 12;
14
+ const gradientSteps = [
15
+ 0, 0.013, 0.049, 0.104, 0.175, 0.259, 0.352, 0.45, 0.55, 0.648, 0.741, 0.825,
16
+ 0.896, 0.951, 0.987,
17
+ ];
18
+ const gradientOpacities = [
19
+ 0, 8.1, 15.5, 22.5, 29, 35.3, 41.2, 47.1, 52.9, 58.8, 64.7, 71, 77.5, 84.5,
20
+ 91.9,
21
+ ];
22
+ const globalGradientOpacity = 1 / 0.7;
14
23
  const containerStyle = {
15
24
  boxSizing: 'border-box',
16
25
  position: 'absolute',
17
26
  bottom: 0,
18
27
  width: '100%',
19
- paddingTop: 10,
28
+ paddingTop: 40,
20
29
  paddingBottom: 10,
21
- background: 'linear-gradient(transparent, rgba(0, 0, 0, 0.4))',
30
+ backgroundImage: `linear-gradient(to bottom,${gradientSteps
31
+ .map((g, i) => {
32
+ return `hsla(0, 0%, 0%, ${g}) ${gradientOpacities[i] * globalGradientOpacity}%`;
33
+ })
34
+ .join(', ')}, hsl(0, 0%, 0%) 100%)`,
35
+ backgroundSize: 'auto 145px',
22
36
  display: 'flex',
23
37
  paddingRight: exports.X_PADDING,
24
38
  paddingLeft: exports.X_PADDING,
File without changes
File without changes
File without changes
File without changes
@@ -35,7 +35,7 @@ const ThumbnailFn = ({ frameToDisplay, style, inputProps, compositionHeight, com
35
35
  const passedInputProps = (0, react_1.useMemo)(() => {
36
36
  return inputProps !== null && inputProps !== void 0 ? inputProps : {};
37
37
  }, [inputProps]);
38
- return ((0, jsx_runtime_1.jsx)(SharedPlayerContext_1.SharedPlayerContexts, { timelineContext: timelineState, component: Component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: 0, children: (0, jsx_runtime_1.jsx)(emitter_context_1.ThumbnailEmitterContext.Provider, { value: emitter, children: (0, jsx_runtime_1.jsx)(ThumbnailUI_1.default, { className: className, errorFallback: errorFallback, inputProps: passedInputProps, renderLoading: renderLoading, style: style }) }) }));
38
+ return ((0, jsx_runtime_1.jsx)(remotion_1.Internals.IsPlayerContextProvider, { children: (0, jsx_runtime_1.jsx)(SharedPlayerContext_1.SharedPlayerContexts, { timelineContext: timelineState, component: Component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: 0, children: (0, jsx_runtime_1.jsx)(emitter_context_1.ThumbnailEmitterContext.Provider, { value: emitter, children: (0, jsx_runtime_1.jsx)(ThumbnailUI_1.default, { className: className, errorFallback: errorFallback, inputProps: passedInputProps, renderLoading: renderLoading, style: style }) }) }) }));
39
39
  };
40
40
  exports.ThumbnailFn = ThumbnailFn;
41
41
  const forward = react_1.forwardRef;
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -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: {
@@ -93,6 +93,6 @@ const useElementSize = (ref, options) => {
93
93
  elementSizeHooks = elementSizeHooks.filter((e) => e !== updateSize);
94
94
  };
95
95
  }, [updateSize]);
96
- return size;
96
+ return size ? { ...size, refresh: updateSize } : null;
97
97
  };
98
98
  exports.useElementSize = useElementSize;
@@ -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);
@@ -0,0 +1,41 @@
1
+ import type { MouseEventHandler, ReactNode } from 'react';
2
+ import React from 'react';
3
+ import type { usePlayer } from './use-player';
4
+ export declare type RenderPlayPauseButton = (props: {
5
+ playing: boolean;
6
+ }) => ReactNode;
7
+ export declare type RenderFullscreenButton = (props: {
8
+ isFullscreen: boolean;
9
+ }) => ReactNode;
10
+ export declare const X_SPACER = 10;
11
+ export declare const X_PADDING = 12;
12
+ declare global {
13
+ interface Document {
14
+ webkitFullscreenEnabled?: boolean;
15
+ webkitFullscreenElement?: Element;
16
+ webkitExitFullscreen?: Document['exitFullscreen'];
17
+ }
18
+ interface HTMLDivElement {
19
+ webkitRequestFullScreen: HTMLDivElement['requestFullscreen'];
20
+ }
21
+ }
22
+ export declare const Controls: React.FC<{
23
+ fps: number;
24
+ durationInFrames: number;
25
+ hovered: boolean;
26
+ showVolumeControls: boolean;
27
+ player: ReturnType<typeof usePlayer>;
28
+ onFullscreenButtonClick: MouseEventHandler<HTMLButtonElement>;
29
+ isFullscreen: boolean;
30
+ allowFullscreen: boolean;
31
+ onExitFullscreenButtonClick: MouseEventHandler<HTMLButtonElement>;
32
+ spaceKeyToPlayOrPause: boolean;
33
+ onSeekEnd: () => void;
34
+ onSeekStart: () => void;
35
+ inFrame: number | null;
36
+ outFrame: number | null;
37
+ initiallyShowControls: number | boolean;
38
+ playerWidth: number;
39
+ renderPlayPauseButton: RenderPlayPauseButton | null;
40
+ renderFullscreenButton: RenderFullscreenButton | null;
41
+ }>;