UNPKG

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