UNPKG

10.5 kBTypeScriptView Raw
1/// <reference types="react" />
2import { CompProps } from './Composition';
3import { CompositionManagerContext, RenderAssetInfo, TAsset, TCompMetadata, TComposition, TSequence } from './CompositionManager';
4import * as AssetCompression from './compress-assets';
5import * as Logging from './config/log';
6import { WebpackOverrideFn } from './config/override-webpack';
7import { ProResProfile } from './config/prores-profile';
8import * as CSSUtils from './default-css';
9import { RemotionEnvironment } from './get-environment';
10import * as perf from './perf';
11import * as TimelineInOutPosition from './timeline-inout-position-state';
12import { SetTimelineInOutContextValue, TimelineInOutContextValue } from './timeline-inout-position-state';
13import * as TimelinePosition from './timeline-position-state';
14import { SetTimelineContextValue, TimelineContextValue } from './timeline-position-state';
15import { truthy } from './truthy';
16import { OpenGlRenderer } from './validation/validate-opengl-renderer';
17import { MediaVolumeContextValue, SetMediaVolumeContextValue } from './volume-position-state';
18import { useRemotionContexts } from './wrap-remotion-context';
19declare const Timeline: {
20 TimelineInOutContext: import("react").Context<TimelineInOutPosition.TimelineInOutContextValue>;
21 SetTimelineInOutContext: import("react").Context<TimelineInOutPosition.SetTimelineInOutContextValue>;
22 useTimelineInOutFramePosition: () => TimelineInOutPosition.TimelineInOutContextValue;
23 useTimelineSetInOutFramePosition: () => TimelineInOutPosition.SetTimelineInOutContextValue;
24 TimelineContext: import("react").Context<TimelinePosition.TimelineContextValue>;
25 SetTimelineContext: import("react").Context<TimelinePosition.SetTimelineContextValue>;
26 useTimelinePosition: () => number;
27 useTimelineSetFrame: () => (u: import("react").SetStateAction<number>) => void;
28 usePlayingState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void, import("react").MutableRefObject<boolean>];
29};
30export declare const Internals: {
31 perf: typeof perf;
32 useUnsafeVideoConfig: () => import("./video-config").VideoConfig | null;
33 Timeline: {
34 TimelineInOutContext: import("react").Context<TimelineInOutPosition.TimelineInOutContextValue>;
35 SetTimelineInOutContext: import("react").Context<TimelineInOutPosition.SetTimelineInOutContextValue>;
36 useTimelineInOutFramePosition: () => TimelineInOutPosition.TimelineInOutContextValue;
37 useTimelineSetInOutFramePosition: () => TimelineInOutPosition.SetTimelineInOutContextValue;
38 TimelineContext: import("react").Context<TimelinePosition.TimelineContextValue>;
39 SetTimelineContext: import("react").Context<TimelinePosition.SetTimelineContextValue>;
40 useTimelinePosition: () => number;
41 useTimelineSetFrame: () => (u: import("react").SetStateAction<number>) => void;
42 usePlayingState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void, import("react").MutableRefObject<boolean>];
43 };
44 CompositionManager: import("react").Context<CompositionManagerContext>;
45 RemotionRoot: import("react").FC<{
46 children: import("react").ReactNode;
47 }>;
48 useVideo: () => TComposition<unknown> | null;
49 getRoot: () => import("react").FC<{}> | null;
50 getBrowserExecutable: () => import("./config/browser-executable").BrowserExecutable;
51 getCustomFfmpegExecutable: () => import("./config/ffmpeg-executable").FfmpegExecutable;
52 getPixelFormat: () => "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
53 getConcurrency: () => number | null;
54 getRange: () => import("./config/frame-range").FrameRange | null;
55 getShouldOverwrite: () => boolean;
56 getOutputCodecOrUndefined: () => import("./config/codec").CodecOrUndefined;
57 getWebpackOverrideFn: () => WebpackOverrideFn;
58 getQuality: () => number | undefined;
59 getScale: () => number;
60 getShouldOutputImageSequence: (frameRange: import("./config/frame-range").FrameRange | null) => boolean;
61 validateSelectedCrfAndCodecCombination: (crf: unknown, codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => void;
62 getFinalOutputCodec: ({ codec: inputCodec, fileExtension, emitWarning, isLambda, }: {
63 codec: import("./config/codec").CodecOrUndefined;
64 fileExtension: string | null;
65 emitWarning: boolean;
66 isLambda: boolean;
67 }) => "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
68 useMediaVolumeState: () => readonly [number, (u: number) => void];
69 useMediaMutedState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void];
70 DEFAULT_CODEC: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
71 DEFAULT_PIXEL_FORMAT: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
72 FEATURE_FLAG_FIREFOX_SUPPORT: boolean;
73 DEFAULT_WEBPACK_CACHE_ENABLED: boolean;
74 getBrowser: () => import("./config/browser").Browser | null;
75 DEFAULT_BROWSER: import("./config/browser").Browser;
76 getDefaultCrfForCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => number;
77 getActualCrf: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => number;
78 setFrameRangeFromCli: (newFrameRange: string | number) => void;
79 getUserPreferredImageFormat: () => "none" | "png" | "jpeg" | undefined;
80 validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", imageFormat: "none" | "png" | "jpeg") => "none" | "valid";
81 validateSelectedPixelFormatAndCodecCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => void;
82 validateFrameRange: (frameRange: import("./config/frame-range").FrameRange | null) => void;
83 validateNonNullImageFormat: (imageFormat: "none" | "png" | "jpeg") => void;
84 getWebpackCaching: () => boolean;
85 useLazyComponent: <T>(compProps: CompProps<T>) => import("react").ExoticComponent<(import("react").PropsWithoutRef<T> & import("react").RefAttributes<import("react").Component<T, any, any>>) | import("react").PropsWithRef<T>> & {
86 readonly _result: import("react").ComponentType<T>;
87 };
88 truthy: typeof truthy;
89 isAudioCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | undefined) => boolean;
90 Logging: typeof Logging;
91 SequenceContext: import("react").Context<import("./sequencing").SequenceContextType | null>;
92 useRemotionContexts: typeof useRemotionContexts;
93 RemotionContextProvider: (props: import("./wrap-remotion-context").RemotionContextProviderProps) => JSX.Element;
94 CSSUtils: typeof CSSUtils;
95 setupEnvVariables: () => void;
96 ENV_VARIABLES_ENV_NAME: "ENV_VARIABLES";
97 getDotEnvLocation: () => string | null;
98 getServerPort: () => number | undefined;
99 MediaVolumeContext: import("react").Context<MediaVolumeContextValue>;
100 SetMediaVolumeContext: import("react").Context<SetMediaVolumeContextValue>;
101 validateDurationInFrames: (durationInFrames: number, component: string) => void;
102 validateFps: (fps: number, location: string) => void;
103 validateDimension: (amount: number, nameOfProp: string, location: string) => void;
104 getRemotionEnvironment: () => RemotionEnvironment;
105 getProResProfile: () => "light" | "4444-xq" | "4444" | "hq" | "standard" | "proxy" | undefined;
106 setProResProfile: (profile: "light" | "4444-xq" | "4444" | "hq" | "standard" | "proxy" | undefined) => void;
107 validateSelectedCodecAndProResCombination: (actualCodec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv", actualProResProfile: "light" | "4444-xq" | "4444" | "hq" | "standard" | "proxy" | undefined) => void;
108 getMaxTimelineTracks: () => number;
109 SharedAudioContext: import("react").Context<{
110 registerAudio: (aud: import("./audio").RemotionAudioProps) => {
111 id: number;
112 props: import("./audio").RemotionAudioProps;
113 el: import("react").RefObject<HTMLAudioElement>;
114 };
115 unregisterAudio: (id: number) => void;
116 updateAudio: (id: number, aud: import("./audio").RemotionAudioProps) => void;
117 playAllAudios: () => void;
118 numberOfAudioTags: number;
119 } | null>;
120 SharedAudioContextProvider: import("react").FC<{
121 numberOfAudioTags: number;
122 children: import("react").ReactNode;
123 }>;
124 validateQuality: (q: number | undefined) => void;
125 validateFrame: (frame: number, durationInFrames: number) => void;
126 setStillFrame: (frame: number) => void;
127 getStillFrame: () => number;
128 invalidCompositionErrorMessage: string;
129 isCompositionIdValid: (id: string) => RegExpMatchArray | null;
130 DEFAULT_OVERWRITE: boolean;
131 AssetCompression: typeof AssetCompression;
132 defaultOverrideFunction: WebpackOverrideFn;
133 DEFAULT_PUPPETEER_TIMEOUT: number;
134 setupPuppeteerTimeout: () => void;
135 setPuppeteerTimeout: (newPuppeteerTimeout: number) => void;
136 getCurrentPuppeteerTimeout: () => number;
137 getChromiumDisableWebSecurity: () => boolean;
138 getIgnoreCertificateErrors: () => boolean;
139 validateOpenGlRenderer: (option: "swangle" | "angle" | "egl" | "swiftshader" | null) => "swangle" | "angle" | "egl" | "swiftshader" | null;
140 getChromiumOpenGlRenderer: () => "swangle" | "angle" | "egl" | "swiftshader" | null;
141 getChromiumHeadlessMode: () => boolean;
142 DEFAULT_OPENGL_RENDERER: "swangle" | "angle" | "egl" | "swiftshader" | null;
143 getPreviewDomElement: () => HTMLElement | null;
144 compositionsRef: import("react").RefObject<{
145 getCompositions: () => TCompMetadata[];
146 }>;
147 DELAY_RENDER_CALLSTACK_TOKEN: string;
148 useAbsoluteCurrentFrame: () => number;
149};
150export type { TComposition, Timeline, TCompMetadata, TSequence, WebpackOverrideFn, TAsset, RenderAssetInfo, TimelineContextValue, SetTimelineContextValue, TimelineInOutContextValue, SetTimelineInOutContextValue, CompProps, CompositionManagerContext, MediaVolumeContextValue, SetMediaVolumeContextValue, RemotionEnvironment, ProResProfile, OpenGlRenderer, };