🎥 Make videos programmatically with React
import type {Caption} from '@remotion/captions';
import React, {useCallback, useRef, useState} from 'react';
import {LIGHT_TEXT} from '../helpers/colors';
import {FOCUS_VISIBLE_ONLY_CLASS_NAME} from '../helpers/hoverable';
import {UploadIcon} from '../icons/upload';
import {SetSelectedModalContext} from '../state/modals';
import {ActionTooltip} from './ActionTooltip';
import {CaptionTextEditor} from './CaptionTextEditor';
import {InlineAction} from './InlineAction';
import {CollapsibleInspectorSectionHeader} from './InspectorPanel/CollapsibleInspectorSectionHeader';
import {InspectorSectionHeader} from './InspectorPanel/common';
import {sectionHeaderEnd} from './InspectorPanel/styles';
import {showNotification} from './Notifications/NotificationCenter';
import {parseCaptionFile} from './parse-caption-file';
const transcriptFileTypes = {
extensions: ['.json', '.srt'],
description:
'Supports SRT, Remotion Caption[] JSON, ElevenLabs Speech-to-Text and segmented JSON, and OpenAI Whisper verbose JSON. Files are processed locally.',
importLabel: 'Import transcript file...',
};
const readOnlyStatus: React.CSSProperties = {
color: LIGHT_TEXT,
fontFamily: 'sans-serif',
fontSize: 12,
fontWeight: 'normal',
lineHeight: '16px',
marginLeft: 12,
};
export const CaptionInspector: React.FC<{
readonly captions: Caption[];
readonly expanded: boolean;
readonly onTextChange: (captions: Caption[]) => void;
readonly onTextSave: ((captions: Caption[]) => void) | null;
readonly onTextCancel: (() => void) | null;
readonly onReplaceCaptions: ((captions: Caption[]) => void) | null;
readonly onToggle: () => void;
readonly readOnly: boolean;
readonly readOnlyTitle: string | null;
}> = ({
captions,
expanded,
onTextChange,
onTextSave,
onTextCancel,
onReplaceCaptions,
onToggle,
readOnly,
readOnlyTitle,
}) => {
const fileInput = useRef<HTMLInputElement>(null);
const expansionRef = useRef({expanded, onToggle});
expansionRef.current = {expanded, onToggle};
const [isImporting, setIsImporting] = useState(false);
const {setSelectedModal} = React.useContext(SetSelectedModalContext);
const importCaptions = useCallback(
async ({
fileName,
contents,
}: {
fileName: string;
contents: Promise<string>;
}) => {
if (onReplaceCaptions === null) {
return;
}
setIsImporting(true);
try {
const imported = parseCaptionFile({
fileName,
contents: await contents,
});
onReplaceCaptions(imported);
if (imported.length > 0 && !expansionRef.current.expanded) {
expansionRef.current.onToggle();
}
} catch (error) {
showNotification(
`Could not import ${fileName}: ${error instanceof Error ? error.message : String(error)}`,
5000,
);
} finally {
setIsImporting(false);
}
},
[onReplaceCaptions],
);
const onFileSelected = useCallback(
(event: React.ChangeEvent<HTMLInputElement>) => {
const file = event.currentTarget.files?.[0];
event.currentTarget.value = '';
if (!file) {
return;
}
importCaptions({fileName: file.name, contents: file.text()}).catch(
() => undefined,
);
},
[importCaptions],
);
const openCaptionSelection = useCallback(() => {
setSelectedModal({
type: 'quick-switcher',
mode: 'assets',
invocationTimestamp: Date.now(),
assetSelection: {
initialQuery: '',
fileTypes: transcriptFileTypes,
onSelectFile: () => fileInput.current?.click(),
onSelected: (asset) => {
return importCaptions({
fileName: asset.name,
contents: fetch(asset.src).then((response) => {
if (!response.ok) {
throw new Error(
`Could not read asset (HTTP ${response.status}). Check that the file is available.`,
);
}
return response.text();
}),
}).catch(() => undefined);
},
},
compositionSelection: null,
});
}, [importCaptions, setSelectedModal]);
return (
<>
<InspectorSectionHeader>
<CollapsibleInspectorSectionHeader
action={
<div style={sectionHeaderEnd}>
{onReplaceCaptions === null ? null : (
<>
<input
ref={fileInput}
accept=".json,.srt"
aria-label="Import captions file"
hidden
onChange={onFileSelected}
type="file"
/>
<ActionTooltip
label="Import transcript"
shortcut={null}
delay={800}
dismissOnClick
>
<InlineAction
aria-label="Import transcript"
className={FOCUS_VISIBLE_ONLY_CLASS_NAME}
disabled={isImporting}
onClick={openCaptionSelection}
renderAction={(color) => (
<UploadIcon
aria-hidden="true"
color={color}
focusable="false"
style={{height: 14, width: 14}}
/>
)}
variant={null}
/>
</ActionTooltip>
</>
)}
{readOnly ? (
<div
role="group"
style={readOnlyStatus}
aria-label={readOnlyTitle ?? undefined}
>
Read only
</div>
) : null}
</div>
}
expanded={expanded}
label="Captions"
onToggle={captions.length > 0 ? onToggle : null}
/>
</InspectorSectionHeader>
{expanded || captions.length === 0 ? (
<CaptionTextEditor
captions={captions}
onChange={onTextChange}
onSave={onTextSave}
onCancel={onTextCancel}
readOnly={readOnly}
/>
) : null}
</>
);
};