Skip to content

🎥 Make videos programmatically with React

`template-audiogram`: Restore reduced schema

JonnyBurger44549b61ea4c
diff --git a/packages/template-audiogram/src/Audiogram/Main.tsx b/packages/template-audiogram/src/Audiogram/Main.tsx
index 3363fe2eeb..6c523344e4 100644
--- a/packages/template-audiogram/src/Audiogram/Main.tsx
+++ b/packages/template-audiogram/src/Audiogram/Main.tsx
@@ -19,9 +19,9 @@ import {
LINES_PER_PAGE,
} from "./constants";
import { FONT_FAMILY } from "./font";
-import type { AudiogramProps } from "./types";
+import type { AudiogramCompositionSchemaType } from "./schema";
-export const Audiogram: React.FC<AudiogramProps> = ({
+export const Audiogram: React.FC<AudiogramCompositionSchemaType> = ({
visualizer,
audioFileUrl,
titleColor,
diff --git a/packages/template-audiogram/src/Audiogram/schema.ts b/packages/template-audiogram/src/Audiogram/schema.ts
new file mode 100644
index 0000000000..226d69dd8b
--- /dev/null
+++ b/packages/template-audiogram/src/Audiogram/schema.ts
@@ -0,0 +1,49 @@
+import type { Caption } from "@remotion/captions";
+import { zColor } from "@remotion/zod-types";
+import { z } from "zod";
+
+const baseVisualizerSchema = z.object({
+ color: zColor(),
+ numberOfSamples: z.enum(["32", "64", "128", "256", "512"]),
+});
+
+const spectrumVisualizerSchema = baseVisualizerSchema.extend({
+ type: z.literal("spectrum"),
+ linesToDisplay: z.number().int().min(0).default(65),
+ freqRangeStartIndex: z.number().int().min(0).default(0),
+ mirrorWave: z.boolean(),
+});
+
+const oscilloscopeVisualizerSchema = baseVisualizerSchema.extend({
+ type: z.literal("oscilloscope"),
+ windowInSeconds: z.number().min(0.1).default(0.1),
+ posterization: z.number().int().min(0.1).default(3),
+ amplitude: z.number().int().min(0.1).default(4),
+ padding: z.number().int().min(0).default(50),
+});
+
+const visualizerSchema = z.discriminatedUnion("type", [
+ spectrumVisualizerSchema,
+ oscilloscopeVisualizerSchema,
+]);
+
+export const audiogramSchema = z.object({
+ // visualizer settings
+ visualizer: visualizerSchema,
+ // podcast data
+ titleColor: zColor(),
+ // captions settings
+ captionsFileName: z
+ .string()
+ .refine((value) => value.endsWith(".srt") || value.endsWith(".json"), {
+ message: "Subtitles file must be a .srt or .json file",
+ }),
+ captionsTextColor: zColor(),
+ onlyDisplayCurrentSentence: z.boolean(),
+ // audio settings
+ audioFileUrl: z.string(),
+});
+
+export type AudiogramCompositionSchemaType = z.infer<typeof audiogramSchema> & {
+ readonly captions: Caption[] | null;
+};
diff --git a/packages/template-audiogram/src/Audiogram/types.ts b/packages/template-audiogram/src/Audiogram/types.ts
deleted file mode 100644
index 89384e0fbc..0000000000
--- a/packages/template-audiogram/src/Audiogram/types.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-import type { Caption } from "@remotion/captions";
-
-type NumberOfSamples = "32" | "64" | "128" | "256" | "512";
-
-type BaseVisualizer = {
- readonly color: string;
- readonly numberOfSamples: NumberOfSamples;
-};
-
-type SpectrumVisualizer = BaseVisualizer & {
- readonly type: "spectrum";
- readonly linesToDisplay: number;
- readonly freqRangeStartIndex: number;
- readonly mirrorWave: boolean;
-};
-
-type OscilloscopeVisualizer = BaseVisualizer & {
- readonly type: "oscilloscope";
- readonly windowInSeconds: number;
- readonly posterization: number;
- readonly amplitude: number;
- readonly padding: number;
-};
-
-export type AudiogramProps = {
- readonly visualizer: SpectrumVisualizer | OscilloscopeVisualizer;
- readonly titleColor: string;
- readonly captionsFileName: string;
- readonly captionsTextColor: string;
- readonly onlyDisplayCurrentSentence: boolean;
- readonly audioFileUrl: string;
- readonly captions: Caption[] | null;
-};
diff --git a/packages/template-audiogram/src/Root.tsx b/packages/template-audiogram/src/Root.tsx
index 07b22c398d..2d8b2cce83 100644
--- a/packages/template-audiogram/src/Root.tsx
+++ b/packages/template-audiogram/src/Root.tsx
@@ -1,6 +1,7 @@
import { parseMedia } from "@remotion/media-parser";
import { Composition, staticFile } from "remotion";
import { Audiogram } from "./Audiogram/Main";
+import { audiogramSchema } from "./Audiogram/schema";
import { getSubtitles } from "./helpers/fetch-captions";
import { FPS } from "./helpers/ms-to-frame";
@@ -12,6 +13,7 @@ export const RemotionRoot: React.FC = () => {
component={Audiogram}
width={1080}
height={1080}
+ schema={audiogramSchema}
defaultProps={{
// audio settings
audioFileUrl: staticFile("dialogue.wav"),