🎥 Make videos programmatically with React
Discover video outlines from the media marker
JonnyBurger33a2d90a93e6
diff --git a/packages/core/src/audio/AudioForPreview.tsx b/packages/core/src/audio/AudioForPreview.tsxindex 18d31d6856..2ea82d85a3 100644--- a/packages/core/src/audio/AudioForPreview.tsx+++ b/packages/core/src/audio/AudioForPreview.tsx@@ -191,7 +191,6 @@ const AudioForDevelopmentForwardRefFunction: React.ForwardRefRenderFunction<loopDisplay: undefined,loopVolumeCurveBehavior: loopVolumeCurveBehavior ?? 'repeat',documentationLink: 'https://www.remotion.dev/docs/html5-audio',- refForOutline: null,muted: isMutedForTimeline,});diff --git a/packages/core/src/test/use-media-in-timeline.test.tsx b/packages/core/src/test/use-media-in-timeline.test.tsxindex 7c9642e0ee..b61e348509 100644--- a/packages/core/src/test/use-media-in-timeline.test.tsx+++ b/packages/core/src/test/use-media-in-timeline.test.tsx@@ -9,6 +9,10 @@ import {} from 'bun:test';import {cleanup, renderHook} from '@testing-library/react';import React, {useMemo} from 'react';+import {+ SequenceOutlineContext,+ SequenceOutlineInternals,+} from '../sequence-outline.js';import type {SequenceManagerContext} from '../SequenceManager.js';import {SequenceManager} from '../SequenceManager.js';import {useMediaInTimeline} from '../use-media-in-timeline.js';@@ -85,7 +89,6 @@ test('useMediaInTimeline registers muted changes and unregisters the sequence',loopDisplay: undefined,loopVolumeCurveBehavior: 'repeat',documentationLink: null,- refForOutline: null,muted,}),{@@ -97,6 +100,7 @@ test('useMediaInTimeline registers muted changes and unregisters the sequence',expect(registerSequence.mock.calls[0]?.[0]).toMatchObject({mediaFrameAtSequenceZero: 0,muted: false,+ refForOutline: null,});rerender({muted: true});@@ -124,15 +128,17 @@ test('useMediaInTimeline keeps documentation links for custom display names', ()}, []);return (- <WrapSequenceContext>- <SequenceManager.Provider value={sequenceManagerContext}>- {children}- </SequenceManager.Provider>- </WrapSequenceContext>+ <SequenceOutlineContext.Provider value>+ <WrapSequenceContext>+ <SequenceManager.Provider value={sequenceManagerContext}>+ {children}+ </SequenceManager.Provider>+ </WrapSequenceContext>+ </SequenceOutlineContext.Provider>);};- renderHook(+ const {result} = renderHook(() =>useMediaInTimeline({volume: 1,@@ -149,7 +155,6 @@ test('useMediaInTimeline keeps documentation links for custom display names', ()loopDisplay: undefined,loopVolumeCurveBehavior: 'repeat',documentationLink: 'https://www.remotion.dev/docs/html5-video',- refForOutline: null,muted: false,}),{@@ -160,5 +165,7 @@ test('useMediaInTimeline keeps documentation links for custom display names', ()expect(registerSequence.mock.calls[0]?.[0]).toMatchObject({displayName: 'Intro',documentationLink: 'https://www.remotion.dev/docs/html5-video',+ refForOutline: result.current,});+ expect(SequenceOutlineInternals.getNodes(result.current!)).toEqual([]);});diff --git a/packages/core/src/use-media-in-timeline.ts b/packages/core/src/use-media-in-timeline.tsindex 50e16c3c77..d2c278f498 100644--- a/packages/core/src/use-media-in-timeline.ts+++ b/packages/core/src/use-media-in-timeline.ts@@ -8,6 +8,10 @@ import type {LoopDisplay, TSequence} from './CompositionManager.js';import {getAssetDisplayName} from './get-asset-file-name.js';import {getTimelineDuration} from './get-timeline-duration.js';import {Loop, LoopTimelineContext} from './loop/index.js';+import {+ SequenceOutlineContext,+ SequenceOutlineInternals,+} from './sequence-outline.js';import {SequenceContext} from './SequenceContext.js';import {SequenceRegistrationContext} from './SequenceManager.js';import {useRemotionEnvironment} from './use-remotion-environment.js';@@ -169,7 +173,6 @@ export const useMediaInTimeline = ({loopDisplay,loopVolumeCurveBehavior,documentationLink,- refForOutline,muted,}: {volume: VolumeProp | undefined;@@ -186,7 +189,6 @@ export const useMediaInTimeline = ({loopDisplay: LoopDisplay | undefined;loopVolumeCurveBehavior: LoopVolumeCurveBehavior;documentationLink: string | null;- refForOutline: React.RefObject<Element | null> | null;muted: boolean;}) => {const parentSequence = useContext(SequenceContext);@@ -196,6 +198,15 @@ export const useMediaInTimeline = ({const mediaStartsAt = useMediaStartsAt();const loopContext = Loop.useLoop();const loopTimeline = useContext(LoopTimelineContext);+ const canvasOutlinesEnabled = useContext(SequenceOutlineContext);+ const {isStudio} = useRemotionEnvironment();+ const automaticOutlineRef = useMemo(+ () =>+ mediaType === 'video' && (isStudio || canvasOutlinesEnabled)+ ? SequenceOutlineInternals.createRef()+ : null,+ [canvasOutlinesEnabled, isStudio, mediaType],+ );const {volumes: basicVolumes,@@ -280,8 +291,6 @@ export const useMediaInTimeline = ({loopVolumeCurveBehavior,]);- const {isStudio} = useRemotionEnvironment();-const getSequenceForRegistration = useCallback((): TSequence => {if (!src) {throw new Error('No src passed');@@ -313,7 +322,7 @@ export const useMediaInTimeline = ({postmountDisplay,controls: null,effects: [],- refForOutline,+ refForOutline: automaticOutlineRef,isInsideSeries: false,frozenFrame: null,frozenMediaFrame: null,@@ -334,7 +343,7 @@ export const useMediaInTimeline = ({loopDisplay,documentationLink,finalDisplayName,- refForOutline,+ automaticOutlineRef,muted,]);const registrationEnabled =@@ -346,4 +355,5 @@ export const useMediaInTimeline = ({registrationEnabled && showInTimeline ? getSequenceForRegistration : null,id,});+ return automaticOutlineRef;};diff --git a/packages/core/src/video/VideoForPreview.tsx b/packages/core/src/video/VideoForPreview.tsxindex a6a82862c8..dc8b40ad77 100644--- a/packages/core/src/video/VideoForPreview.tsx+++ b/packages/core/src/video/VideoForPreview.tsx@@ -165,7 +165,7 @@ const VideoForDevelopmentRefForwardingFunction: React.ForwardRefRenderFunction<return _remotionInternalStack ?? null;}, [_remotionInternalStack]);- useMediaInTimeline({+ const automaticOutlineRef = useMediaInTimeline({volume,mediaVolume,mediaType: 'video',@@ -182,7 +182,6 @@ const VideoForDevelopmentRefForwardingFunction: React.ForwardRefRenderFunction<documentationLink: onlyWarnForMediaSeekingError? 'https://www.remotion.dev/docs/offthreadvideo': 'https://www.remotion.dev/docs/html5-video',- refForOutline: videoRef,muted: isMutedForTimeline,});@@ -372,8 +371,11 @@ const VideoForDevelopmentRefForwardingFunction: React.ForwardRefRenderFunction</>);- return isStudio ? (- <SequenceOrderMarker sequenceId={timelineId} outlineChildrenRef={null}>+ return isStudio || automaticOutlineRef ? (+ <SequenceOrderMarker+ sequenceId={timelineId}+ outlineChildrenRef={automaticOutlineRef}+ >{video}</SequenceOrderMarker>) : (