@remotion/player 4.0.212 → 4.0.214

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 (113) hide show
  1. package/dist/cjs/DefaultPlayPauseButton.d.ts +0 -1
  2. package/dist/cjs/PlayerControls.js +2 -2
  3. package/dist/cjs/PlayerSeekBar.d.ts +0 -1
  4. package/dist/cjs/PlayerSeekBar.js +1 -2
  5. package/dist/cjs/PlayerUI.d.ts +3 -3
  6. package/dist/cjs/PlayerUI.js +8 -2
  7. package/dist/cjs/ThumbnailUI.d.ts +1 -1
  8. package/dist/cjs/ThumbnailUI.js +8 -2
  9. package/dist/cjs/calculate-scale.d.ts +3 -2
  10. package/dist/cjs/calculate-scale.js +2 -1
  11. package/dist/cjs/index.d.ts +7 -8
  12. package/dist/cjs/is-backgrounded.d.ts +0 -1
  13. package/dist/cjs/test/test-utils.d.ts +1 -1
  14. package/dist/cjs/utils/calculate-player-size.d.ts +2 -2
  15. package/dist/cjs/utils/use-component-visible.d.ts +0 -1
  16. package/dist/cjs/utils/use-component-visible.js +1 -1
  17. package/dist/esm/index.mjs +19 -5
  18. package/package.json +3 -3
  19. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/BufferingIndicator.d.ts +0 -5
  20. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/BufferingIndicator.js +0 -38
  21. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/DefaultPlayPauseButton.d.ts +0 -5
  22. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/DefaultPlayPauseButton.js +0 -12
  23. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/EmitterProvider.d.ts +0 -5
  24. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/EmitterProvider.js +0 -20
  25. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/MediaVolumeSlider.d.ts +0 -5
  26. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/MediaVolumeSlider.js +0 -129
  27. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlaybackrateControl.d.ts +0 -8
  28. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlaybackrateControl.js +0 -156
  29. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Player.d.ts +0 -56
  30. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Player.js +0 -143
  31. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerControls.d.ts +0 -47
  32. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerControls.js +0 -176
  33. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerSeekBar.d.ts +0 -8
  34. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerSeekBar.js +0 -145
  35. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerUI.d.ts +0 -46
  36. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerUI.js +0 -369
  37. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/SharedPlayerContext.d.ts +0 -15
  38. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/SharedPlayerContext.js +0 -55
  39. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Thumbnail.d.ts +0 -23
  40. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Thumbnail.js +0 -48
  41. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/ThumbnailUI.d.ts +0 -11
  42. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/ThumbnailUI.js +0 -89
  43. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-next-frame.d.ts +0 -14
  44. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-next-frame.js +0 -24
  45. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-scale.d.ts +0 -50
  46. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-scale.js +0 -72
  47. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/emitter-context.d.ts +0 -4
  48. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/emitter-context.js +0 -3
  49. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/error-boundary.d.ts +0 -19
  50. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/error-boundary.js +0 -32
  51. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/event-emitter.d.ts +0 -91
  52. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/event-emitter.js +0 -114
  53. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/format-time.d.ts +0 -1
  54. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/format-time.js +0 -5
  55. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/icons.d.ts +0 -10
  56. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/icons.js +0 -39
  57. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/index.d.ts +0 -64
  58. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/index.js +0 -23
  59. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/is-backgrounded.d.ts +0 -2
  60. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/is-backgrounded.js +0 -20
  61. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-css-classname.d.ts +0 -1
  62. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-css-classname.js +0 -1
  63. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-methods.d.ts +0 -25
  64. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-methods.js +0 -1
  65. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/index.test.d.ts +0 -1
  66. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/index.test.js +0 -7
  67. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/test-utils.d.ts +0 -6
  68. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/test-utils.js +0 -14
  69. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-in-out-frames.test.d.ts +0 -1
  70. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-in-out-frames.test.js +0 -54
  71. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-prop.test.d.ts +0 -1
  72. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-prop.test.js +0 -129
  73. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-buffer-state-emitter.d.ts +0 -2
  74. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-buffer-state-emitter.js +0 -22
  75. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-hover-state.d.ts +0 -1
  76. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-hover-state.js +0 -43
  77. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-playback.d.ts +0 -8
  78. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-playback.js +0 -157
  79. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-player.d.ts +0 -24
  80. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-player.js +0 -157
  81. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-thumbnail.d.ts +0 -6
  82. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-thumbnail.js +0 -14
  83. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-video-controls-resize.d.ts +0 -11
  84. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-video-controls-resize.js +0 -35
  85. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/calculate-player-size.d.ts +0 -9
  86. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/calculate-player-size.js +0 -24
  87. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/cancellable-promise.d.ts +0 -5
  88. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/cancellable-promise.js +0 -22
  89. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/delay.d.ts +0 -1
  90. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/delay.js +0 -2
  91. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/is-node.d.ts +0 -1
  92. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/is-node.js +0 -1
  93. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/props-if-has-props.d.ts +0 -10
  94. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/props-if-has-props.js +0 -1
  95. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-cancellable-promises.d.ts +0 -7
  96. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-cancellable-promises.js +0 -18
  97. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-click-prevention-on-double-click.d.ts +0 -3
  98. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-click-prevention-on-double-click.js +0 -41
  99. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-component-visible.d.ts +0 -6
  100. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-component-visible.js +0 -18
  101. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-element-size.d.ts +0 -16
  102. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-element-size.js +0 -127
  103. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-in-out-frame.d.ts +0 -6
  104. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-in-out-frame.js +0 -49
  105. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-initial-frame.d.ts +0 -4
  106. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-initial-frame.js +0 -23
  107. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-playbackrate.d.ts +0 -1
  108. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-playbackrate.js +0 -14
  109. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/validate.d.ts +0 -5
  110. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/validate.js +0 -6
  111. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/volume-persistance.d.ts +0 -2
  112. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/volume-persistance.js +0 -29
  113. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/tsconfig-esm.tsbuildinfo +0 -1
@@ -1,64 +0,0 @@
1
- /// <reference types="react" />
2
- import type { CallbackListener, PlayerEventTypes } from './event-emitter.js';
3
- import { PlayerEmitter } from './event-emitter.js';
4
- export { PlayerMethods, PlayerRef, ThumbnailMethods, ThumbnailRef, } from './player-methods.js';
5
- export { Player, PlayerProps } from './Player.js';
6
- export type { RenderFullscreenButton, RenderPlayPauseButton, } from './PlayerControls.js';
7
- export type { ErrorFallback, RenderLoading, RenderPoster } from './PlayerUI.js';
8
- export { Thumbnail } from './Thumbnail.js';
9
- export { Size } from './utils/use-element-size.js';
10
- export type { CallbackListener, PlayerEventTypes as EventTypes };
11
- export declare const PlayerInternals: {
12
- PlayerEventEmitterContext: import("react").Context<PlayerEmitter | undefined>;
13
- PlayerEmitter: typeof PlayerEmitter;
14
- usePlayer: () => {
15
- frameBack: (frames: number) => void;
16
- frameForward: (frames: number) => void;
17
- isLastFrame: boolean;
18
- isFirstFrame: boolean;
19
- emitter: PlayerEmitter;
20
- playing: boolean;
21
- play: (e?: import("react").SyntheticEvent<Element, Event> | undefined) => void;
22
- pause: () => void;
23
- pauseAndReturnToPlayStart: () => void;
24
- seek: (newFrame: number) => void;
25
- getCurrentFrame: () => number;
26
- isPlaying: () => boolean;
27
- hasPlayed: boolean;
28
- isBuffering: () => boolean;
29
- remotionInternal_currentFrameRef: import("react").MutableRefObject<number>;
30
- };
31
- usePlayback: ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, outFrame, frameRef, }: {
32
- loop: boolean;
33
- playbackRate: number;
34
- moveToBeginningWhenEnded: boolean;
35
- inFrame: number | null;
36
- outFrame: number | null;
37
- frameRef: import("react").MutableRefObject<number>;
38
- }) => void;
39
- useElementSize: (ref: import("react").RefObject<HTMLElement>, options: {
40
- triggerOnWindowResize: boolean;
41
- shouldApplyCssTransforms: boolean;
42
- }) => import("./utils/use-element-size.js").Size | null;
43
- calculateCanvasTransformation: ({ previewSize, compositionWidth, compositionHeight, canvasSize, }: {
44
- previewSize: number | "auto";
45
- compositionWidth: number;
46
- compositionHeight: number;
47
- canvasSize: import("./utils/use-element-size.js").Size;
48
- }) => {
49
- centerX: number;
50
- centerY: number;
51
- xCorrection: number;
52
- yCorrection: number;
53
- scale: number;
54
- };
55
- useHoverState: (ref: import("react").RefObject<HTMLDivElement>, hideControlsWhenPointerDoesntMove: number | boolean) => boolean;
56
- updateAllElementsSizes: () => void;
57
- PlayerEmitterProvider: import("react").FC<{
58
- children: import("react").ReactNode;
59
- currentPlaybackRate: number | null;
60
- }>;
61
- BufferingIndicator: import("react").FC<{
62
- type: "player" | "studio";
63
- }>;
64
- };
@@ -1,23 +0,0 @@
1
- import { BufferingIndicator } from './BufferingIndicator.js';
2
- import { calculateCanvasTransformation } from './calculate-scale.js';
3
- import { PlayerEventEmitterContext } from './emitter-context.js';
4
- import { PlayerEmitterProvider } from './EmitterProvider.js';
5
- import { PlayerEmitter } from './event-emitter.js';
6
- import { useHoverState } from './use-hover-state.js';
7
- import { usePlayback } from './use-playback.js';
8
- import { usePlayer } from './use-player.js';
9
- import { updateAllElementsSizes, useElementSize, } from './utils/use-element-size.js';
10
- export { Player } from './Player.js';
11
- export { Thumbnail } from './Thumbnail.js';
12
- export const PlayerInternals = {
13
- PlayerEventEmitterContext,
14
- PlayerEmitter,
15
- usePlayer,
16
- usePlayback,
17
- useElementSize,
18
- calculateCanvasTransformation,
19
- useHoverState,
20
- updateAllElementsSizes,
21
- PlayerEmitterProvider,
22
- BufferingIndicator,
23
- };
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare const useIsBackgrounded: () => import("react").MutableRefObject<boolean>;
@@ -1,20 +0,0 @@
1
- import { useEffect, useRef } from 'react';
2
- const getIsBackgrounded = () => {
3
- if (typeof document === 'undefined') {
4
- return false;
5
- }
6
- return document.visibilityState === 'hidden';
7
- };
8
- export const useIsBackgrounded = () => {
9
- const isBackgrounded = useRef(getIsBackgrounded());
10
- useEffect(() => {
11
- const onVisibilityChange = () => {
12
- isBackgrounded.current = getIsBackgrounded();
13
- };
14
- document.addEventListener('visibilitychange', onVisibilityChange);
15
- return () => {
16
- document.removeEventListener('visibilitychange', onVisibilityChange);
17
- };
18
- }, []);
19
- return isBackgrounded;
20
- };
@@ -1 +0,0 @@
1
- export declare const PLAYER_CSS_CLASSNAME = "__remotion-player";
@@ -1 +0,0 @@
1
- export const PLAYER_CSS_CLASSNAME = '__remotion-player';
@@ -1,25 +0,0 @@
1
- import type { SyntheticEvent } from 'react';
2
- import type { PlayerEmitter, ThumbnailEmitter } from './event-emitter.js';
3
- export type ThumbnailMethods = {
4
- getContainerNode: () => HTMLDivElement | null;
5
- getScale: () => number;
6
- };
7
- export type PlayerMethods = ThumbnailMethods & {
8
- play: (e?: SyntheticEvent) => void;
9
- pause: () => void;
10
- toggle: (e?: SyntheticEvent) => void;
11
- seekTo: (frame: number) => void;
12
- getCurrentFrame: () => number;
13
- requestFullscreen: () => void;
14
- exitFullscreen: () => void;
15
- isFullscreen: () => boolean;
16
- setVolume: (num: number) => void;
17
- getVolume: () => number;
18
- isMuted: () => boolean;
19
- isPlaying: () => boolean;
20
- mute: () => void;
21
- unmute: () => void;
22
- pauseAndReturnToPlayStart: () => void;
23
- };
24
- export type ThumbnailRef = ThumbnailEmitter & ThumbnailMethods;
25
- export type PlayerRef = PlayerEmitter & PlayerMethods;
@@ -1,7 +0,0 @@
1
- import { expect, test } from 'vitest';
2
- import { usePlayer } from '../use-player.js';
3
- test('It should throw an error if not being used inside a RemotionRoot', () => {
4
- expect(() => {
5
- usePlayer();
6
- }).toThrow();
7
- });
@@ -1,6 +0,0 @@
1
- import type { queries, RenderOptions } from '@testing-library/react';
2
- import type { FC, ReactElement } from 'react';
3
- declare const HelloWorld: FC;
4
- declare const customRender: (ui: ReactElement, options?: Omit<RenderOptions, 'queries'>) => import("@testing-library/react").RenderResult<typeof queries, HTMLElement, HTMLElement>;
5
- export * from '@testing-library/react';
6
- export { customRender as render, HelloWorld };
@@ -1,14 +0,0 @@
1
- import { jsx as _jsx } from "react/jsx-runtime";
2
- import { render } from '@testing-library/react';
3
- const HelloWorld = () => {
4
- return _jsx("div", { children: "Hello World" });
5
- };
6
- const AllTheProviders = ({ children }) => {
7
- // overwriting console.error console does not gets poluted with all the errors
8
- // eslint-disable-next-line @typescript-eslint/no-empty-function
9
- window.console.error = () => { };
10
- return _jsx("div", { children: children });
11
- };
12
- const customRender = (ui, options) => render(ui, { wrapper: AllTheProviders, ...options });
13
- export * from '@testing-library/react';
14
- export { customRender as render, HelloWorld };
@@ -1,54 +0,0 @@
1
- import { expect, test } from 'vitest';
2
- import { validateInOutFrames } from '../utils/validate-in-out-frame.js';
3
- test('Validate in out frames', () => {
4
- expect(() => validateInOutFrames({
5
- durationInFrames: 200,
6
- inFrame: 201,
7
- outFrame: undefined,
8
- })).toThrow(/inFrame must be less than \(durationInFrames - 1\)/);
9
- expect(() => validateInOutFrames({
10
- durationInFrames: 200,
11
- inFrame: 199,
12
- outFrame: 201,
13
- })).toThrow(/outFrame must be less than \(durationInFrames - 1\)/);
14
- expect(() => validateInOutFrames({
15
- durationInFrames: 200,
16
- inFrame: -10,
17
- outFrame: null,
18
- })).toThrow(/inFrame must be greater than 0, but is -10/);
19
- expect(() => validateInOutFrames({
20
- durationInFrames: 200,
21
- inFrame: null,
22
- outFrame: -10,
23
- })).toThrow(/outFrame must be greater than 0, but is -10/);
24
- expect(() => validateInOutFrames({
25
- durationInFrames: 200,
26
- inFrame: 1.5,
27
- outFrame: null,
28
- })).toThrow(/"inFrame" must be an integer, but is 1.5/);
29
- expect(() => validateInOutFrames({
30
- durationInFrames: 200,
31
- inFrame: 20,
32
- outFrame: 20,
33
- })).toThrow(/outFrame must be greater than inFrame, but is 20/);
34
- expect(() => validateInOutFrames({
35
- durationInFrames: 200,
36
- inFrame: 21,
37
- outFrame: 20,
38
- })).toThrow(/outFrame must be greater than inFrame, but is 20 <= 21/);
39
- expect(() => validateInOutFrames({
40
- durationInFrames: 200,
41
- inFrame: null,
42
- outFrame: 20,
43
- })).not.toThrow();
44
- expect(() => validateInOutFrames({
45
- durationInFrames: 200,
46
- inFrame: null,
47
- outFrame: null,
48
- })).not.toThrow();
49
- expect(() => validateInOutFrames({
50
- durationInFrames: 200,
51
- inFrame: 10,
52
- outFrame: 20,
53
- })).not.toThrow();
54
- });
@@ -1,129 +0,0 @@
1
- import { jsx as _jsx } from "react/jsx-runtime";
2
- import { Composition } from 'remotion';
3
- import { expect, test } from 'vitest';
4
- import { Player } from '../index.js';
5
- import { HelloWorld, render } from './test-utils.js';
6
- test('no compositionWidth should give errors', () => {
7
- try {
8
- render(_jsx(Player
9
- // @ts-expect-error
10
- , {
11
- // @ts-expect-error
12
- compositionWidth: null, errorFallback: () => 'something went wrong', compositionHeight: 400, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true }));
13
- }
14
- catch (e) {
15
- expect(e.message).toMatch(/'compositionWidth' must be a number but got 'object' instead/);
16
- }
17
- });
18
- test('no compositionHeight should give errors', () => {
19
- try {
20
- render(_jsx(Player, { compositionWidth: 400, errorFallback: () => 'something went wrong',
21
- // @ts-expect-error
22
- compositionHeight: undefined, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true }));
23
- }
24
- catch (e) {
25
- expect(e.message).toMatch(/'compositionHeight' must be a number but got 'undefined' instead/);
26
- }
27
- });
28
- test('No fps should give errors', () => {
29
- try {
30
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, errorFallback: () => 'something went wrong',
31
- // @ts-expect-error
32
- fps: null, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true }));
33
- }
34
- catch (e) {
35
- expect(e.message).toMatch(/"fps" must be a number, but you passed a value of type object/);
36
- }
37
- try {
38
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, errorFallback: () => 'something went wrong',
39
- // @ts-expect-error
40
- fps: undefined, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true }));
41
- }
42
- catch (e) {
43
- expect(e.message).toMatch(/"fps" must be a number, but you passed a value of type undefined/);
44
- }
45
- });
46
- test('No durationInFrames should give errors', () => {
47
- try {
48
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, errorFallback: () => 'something went wrong', fps: 30,
49
- // @ts-expect-error
50
- durationInFrames: undefined, component: HelloWorld, controls: true, showVolumeControls: true }));
51
- }
52
- catch (e) {
53
- expect(e.message).toMatch(/durationInFrames` must be a number, but is undefined/);
54
- }
55
- });
56
- test('Invalid playbackRate should give error', () => {
57
- try {
58
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true, playbackRate: -5, inputProps: {} }));
59
- }
60
- catch (e) {
61
- expect(e.message).toMatch(/The lowest possible playback rate is -4. You passed: -5/);
62
- }
63
- });
64
- test('playbackRate of 0 should not be possible', () => {
65
- try {
66
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true, playbackRate: 0 }));
67
- }
68
- catch (e) {
69
- expect(e.message).toMatch(/A playback rate of 0 is not supported./);
70
- }
71
- });
72
- test('playbackRate of wrong type should not be possible', () => {
73
- try {
74
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true,
75
- // @ts-expect-error
76
- playbackRate: 'hi' }));
77
- }
78
- catch (e) {
79
- expect(e.message).toMatch(/A playback rate of 0 is not supported./);
80
- }
81
- });
82
- test('playbackRate of undefined should be okay', () => {
83
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: HelloWorld, controls: true, showVolumeControls: true }));
84
- expect(true).toBe(true);
85
- });
86
- test('passing in <Composition /> instance should not be possible', () => {
87
- expect(() => {
88
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: Composition, controls: true, showVolumeControls: true, inputProps: {
89
- id: 'HelloWorld',
90
- width: 500,
91
- height: 400,
92
- fps: 30,
93
- durationInFrames: 500,
94
- component: HelloWorld,
95
- } }));
96
- }).toThrow(/'component' must not be the 'Composition' component\. Pass your own React/);
97
- });
98
- test('passing in <Composition /> instance should not be possible', () => {
99
- expect(() => {
100
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500,
101
- // @ts-expect-error
102
- component: _jsx(Composition, { durationInFrames: 30, fps: 30, height: 10, width: 10, id: "hello", component: HelloWorld }), controls: true, showVolumeControls: true, inputProps: {
103
- id: 'HelloWorld',
104
- width: 500,
105
- height: 400,
106
- fps: 30,
107
- durationInFrames: 500,
108
- component: HelloWorld,
109
- } }));
110
- }).toThrow(/'component' should not be an instance of <Composition\/>\. Pass the React component dir/);
111
- });
112
- test.each([
113
- ['controls'],
114
- ['loop'],
115
- ['autoPlay'],
116
- ['showVolumeControls'],
117
- ['allowFullscreen'],
118
- ['clickToPlay'],
119
- ['doubleClickToFullscreen'],
120
- ])('No durationInFrames should give errors %s', (a) => {
121
- const props = {};
122
- props[a] = 'hey';
123
- try {
124
- render(_jsx(Player, { compositionWidth: 500, compositionHeight: 400, errorFallback: () => 'something went wrong', fps: 30, durationInFrames: 100, component: HelloWorld, ...props }));
125
- }
126
- catch (e) {
127
- expect(e.message).toMatch(`'${a}' must be a boolean or undefined but got 'string' instead`);
128
- }
129
- });
@@ -1,2 +0,0 @@
1
- import type { PlayerEmitter, ThumbnailEmitter } from './event-emitter.js';
2
- export declare const useBufferStateEmitter: (emitter: PlayerEmitter | ThumbnailEmitter) => void;
@@ -1,22 +0,0 @@
1
- import { useContext, useEffect } from 'react';
2
- import { Internals } from 'remotion';
3
- export const useBufferStateEmitter = (emitter) => {
4
- const bufferManager = useContext(Internals.BufferingContextReact);
5
- if (!bufferManager) {
6
- throw new Error('BufferingContextReact not found');
7
- }
8
- useEffect(() => {
9
- const clear1 = bufferManager.listenForBuffering(() => {
10
- bufferManager.buffering.current = true;
11
- emitter.dispatchWaiting({});
12
- });
13
- const clear2 = bufferManager.listenForResume(() => {
14
- bufferManager.buffering.current = false;
15
- emitter.dispatchResume({});
16
- });
17
- return () => {
18
- clear1.remove();
19
- clear2.remove();
20
- };
21
- }, [bufferManager, emitter]);
22
- };
@@ -1 +0,0 @@
1
- export declare const useHoverState: (ref: React.RefObject<HTMLDivElement>, hideControlsWhenPointerDoesntMove: boolean | number) => boolean;
@@ -1,43 +0,0 @@
1
- import { useEffect, useState } from 'react';
2
- export const useHoverState = (ref, hideControlsWhenPointerDoesntMove) => {
3
- const [hovered, setHovered] = useState(false);
4
- useEffect(() => {
5
- const { current } = ref;
6
- if (!current) {
7
- return;
8
- }
9
- let hoverTimeout;
10
- const addHoverTimeout = () => {
11
- if (hideControlsWhenPointerDoesntMove) {
12
- clearTimeout(hoverTimeout);
13
- hoverTimeout = setTimeout(() => {
14
- setHovered(false);
15
- }, hideControlsWhenPointerDoesntMove === true
16
- ? 3000
17
- : hideControlsWhenPointerDoesntMove);
18
- }
19
- };
20
- const onHover = () => {
21
- setHovered(true);
22
- addHoverTimeout();
23
- };
24
- const onLeave = () => {
25
- setHovered(false);
26
- clearTimeout(hoverTimeout);
27
- };
28
- const onMove = () => {
29
- setHovered(true);
30
- addHoverTimeout();
31
- };
32
- current.addEventListener('mouseenter', onHover);
33
- current.addEventListener('mouseleave', onLeave);
34
- current.addEventListener('mousemove', onMove);
35
- return () => {
36
- current.removeEventListener('mouseenter', onHover);
37
- current.removeEventListener('mouseleave', onLeave);
38
- current.removeEventListener('mousemove', onMove);
39
- clearTimeout(hoverTimeout);
40
- };
41
- }, [hideControlsWhenPointerDoesntMove, ref]);
42
- return hovered;
43
- };
@@ -1,8 +0,0 @@
1
- export declare const usePlayback: ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, outFrame, frameRef, }: {
2
- loop: boolean;
3
- playbackRate: number;
4
- moveToBeginningWhenEnded: boolean;
5
- inFrame: number | null;
6
- outFrame: number | null;
7
- frameRef: React.MutableRefObject<number>;
8
- }) => void;
@@ -1,157 +0,0 @@
1
- /* eslint-disable @typescript-eslint/no-use-before-define */
2
- import { useContext, useEffect, useRef } from 'react';
3
- import { Internals } from 'remotion';
4
- import { calculateNextFrame } from './calculate-next-frame.js';
5
- import { useIsBackgrounded } from './is-backgrounded.js';
6
- import { usePlayer } from './use-player.js';
7
- export const usePlayback = ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, outFrame, frameRef, }) => {
8
- const config = Internals.useUnsafeVideoConfig();
9
- const frame = Internals.Timeline.useTimelinePosition();
10
- const { playing, pause, emitter } = usePlayer();
11
- const setFrame = Internals.Timeline.useTimelineSetFrame();
12
- const buffering = useRef(null);
13
- // requestAnimationFrame() does not work if the tab is not active.
14
- // This means that audio will keep playing even if it has ended.
15
- // In that case, we use setTimeout() instead.
16
- const isBackgroundedRef = useIsBackgrounded();
17
- const lastTimeUpdateEvent = useRef(null);
18
- const context = useContext(Internals.BufferingContextReact);
19
- if (!context) {
20
- throw new Error('Missing the buffering context. Most likely you have a Remotion version mismatch.');
21
- }
22
- useEffect(() => {
23
- const onBufferClear = context.listenForBuffering(() => {
24
- buffering.current = performance.now();
25
- });
26
- const onResumeClear = context.listenForResume(() => {
27
- buffering.current = null;
28
- });
29
- return () => {
30
- onBufferClear.remove();
31
- onResumeClear.remove();
32
- };
33
- }, [context]);
34
- useEffect(() => {
35
- if (!config) {
36
- return;
37
- }
38
- if (!playing) {
39
- return;
40
- }
41
- let hasBeenStopped = false;
42
- let reqAnimFrameCall = null;
43
- let startedTime = performance.now();
44
- let framesAdvanced = 0;
45
- const cancelQueuedFrame = () => {
46
- if (reqAnimFrameCall !== null) {
47
- if (reqAnimFrameCall.type === 'raf') {
48
- cancelAnimationFrame(reqAnimFrameCall.id);
49
- }
50
- else {
51
- clearTimeout(reqAnimFrameCall.id);
52
- }
53
- }
54
- };
55
- const stop = () => {
56
- hasBeenStopped = true;
57
- cancelQueuedFrame();
58
- };
59
- const callback = () => {
60
- const time = performance.now() - startedTime;
61
- const actualLastFrame = outFrame !== null && outFrame !== void 0 ? outFrame : config.durationInFrames - 1;
62
- const actualFirstFrame = inFrame !== null && inFrame !== void 0 ? inFrame : 0;
63
- const currentFrame = frameRef.current;
64
- const { nextFrame, framesToAdvance, hasEnded } = calculateNextFrame({
65
- time,
66
- currentFrame,
67
- playbackSpeed: playbackRate,
68
- fps: config.fps,
69
- actualFirstFrame,
70
- actualLastFrame,
71
- framesAdvanced,
72
- shouldLoop: loop,
73
- });
74
- framesAdvanced += framesToAdvance;
75
- if (nextFrame !== frameRef.current &&
76
- (!hasEnded || moveToBeginningWhenEnded)) {
77
- setFrame((c) => ({ ...c, [config.id]: nextFrame }));
78
- }
79
- if (hasEnded) {
80
- stop();
81
- pause();
82
- emitter.dispatchEnded();
83
- return;
84
- }
85
- if (!hasBeenStopped) {
86
- queueNextFrame();
87
- }
88
- };
89
- const queueNextFrame = () => {
90
- if (buffering.current) {
91
- const stopListening = context.listenForResume(() => {
92
- stopListening.remove();
93
- if (hasBeenStopped) {
94
- return;
95
- }
96
- startedTime = performance.now();
97
- framesAdvanced = 0;
98
- callback();
99
- });
100
- return;
101
- }
102
- if (isBackgroundedRef.current) {
103
- reqAnimFrameCall = {
104
- type: 'timeout',
105
- // Note: Most likely, this will not be 1000 / fps, but the browser will throttle it to ~1/sec.
106
- id: setTimeout(callback, 1000 / config.fps),
107
- };
108
- }
109
- else {
110
- reqAnimFrameCall = { type: 'raf', id: requestAnimationFrame(callback) };
111
- }
112
- };
113
- queueNextFrame();
114
- const onVisibilityChange = () => {
115
- if (document.visibilityState === 'visible') {
116
- return;
117
- }
118
- // If tab goes into the background, cancel requestAnimationFrame() and update immediately.
119
- // , so the transition to setTimeout() can be fulfilled.
120
- cancelQueuedFrame();
121
- callback();
122
- };
123
- window.addEventListener('visibilitychange', onVisibilityChange);
124
- return () => {
125
- window.removeEventListener('visibilitychange', onVisibilityChange);
126
- stop();
127
- };
128
- }, [
129
- config,
130
- loop,
131
- pause,
132
- playing,
133
- setFrame,
134
- emitter,
135
- playbackRate,
136
- inFrame,
137
- outFrame,
138
- moveToBeginningWhenEnded,
139
- isBackgroundedRef,
140
- frameRef,
141
- buffering,
142
- context,
143
- ]);
144
- useEffect(() => {
145
- const interval = setInterval(() => {
146
- if (lastTimeUpdateEvent.current === frameRef.current) {
147
- return;
148
- }
149
- emitter.dispatchTimeUpdate({ frame: frameRef.current });
150
- lastTimeUpdateEvent.current = frameRef.current;
151
- }, 250);
152
- return () => clearInterval(interval);
153
- }, [emitter, frameRef]);
154
- useEffect(() => {
155
- emitter.dispatchFrameUpdate({ frame });
156
- }, [emitter, frame]);
157
- };
@@ -1,24 +0,0 @@
1
- import type { SyntheticEvent } from 'react';
2
- import type { PlayerEmitter } from './event-emitter.js';
3
- type UsePlayerMethods = {
4
- frameBack: (frames: number) => void;
5
- frameForward: (frames: number) => void;
6
- isLastFrame: boolean;
7
- isFirstFrame: boolean;
8
- emitter: PlayerEmitter;
9
- playing: boolean;
10
- play: (e?: SyntheticEvent) => void;
11
- pause: () => void;
12
- pauseAndReturnToPlayStart: () => void;
13
- seek: (newFrame: number) => void;
14
- getCurrentFrame: () => number;
15
- isPlaying: () => boolean;
16
- hasPlayed: boolean;
17
- isBuffering: () => boolean;
18
- /**
19
- * @deprecated Remotion internal API
20
- */
21
- remotionInternal_currentFrameRef: React.MutableRefObject<number>;
22
- };
23
- export declare const usePlayer: () => UsePlayerMethods;
24
- export {};