UNPKG

9.48 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';
17import * as AssetCompression from './compress-assets';
18declare const Timeline: {
19 TimelineInOutContext: import("react").Context<TimelineInOutPosition.TimelineInOutContextValue>;
20 SetTimelineInOutContext: import("react").Context<TimelineInOutPosition.SetTimelineInOutContextValue>;
21 useTimelineInOutFramePosition: () => TimelineInOutPosition.TimelineInOutContextValue;
22 useTimelineSetInOutFramePosition: () => TimelineInOutPosition.SetTimelineInOutContextValue;
23 TimelineContext: import("react").Context<TimelinePosition.TimelineContextValue>;
24 SetTimelineContext: import("react").Context<TimelinePosition.SetTimelineContextValue>;
25 useTimelinePosition: () => number;
26 useTimelineSetFrame: () => (u: import("react").SetStateAction<number>) => void;
27 usePlayingState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void, import("react").MutableRefObject<boolean>];
28};
29export declare const Internals: {
30 perf: typeof perf;
31 useUnsafeVideoConfig: () => import("./video-config").VideoConfig | null;
32 Timeline: {
33 TimelineInOutContext: import("react").Context<TimelineInOutPosition.TimelineInOutContextValue>;
34 SetTimelineInOutContext: import("react").Context<TimelineInOutPosition.SetTimelineInOutContextValue>;
35 useTimelineInOutFramePosition: () => TimelineInOutPosition.TimelineInOutContextValue;
36 useTimelineSetInOutFramePosition: () => TimelineInOutPosition.SetTimelineInOutContextValue;
37 TimelineContext: import("react").Context<TimelinePosition.TimelineContextValue>;
38 SetTimelineContext: import("react").Context<TimelinePosition.SetTimelineContextValue>;
39 useTimelinePosition: () => number;
40 useTimelineSetFrame: () => (u: import("react").SetStateAction<number>) => void;
41 usePlayingState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void, import("react").MutableRefObject<boolean>];
42 };
43 CompositionManager: import("react").Context<CompositionManagerContext>;
44 RemotionRoot: import("react").FC<{}>;
45 useVideo: () => TComposition<unknown> | null;
46 getRoot: () => import("react").FC<{}> | null;
47 getBrowserExecutable: () => import("./config/browser-executable").BrowserExecutable;
48 getCustomFfmpegExecutable: () => import("./config/ffmpeg-executable").FfmpegExecutable;
49 getCompositionName: () => string | null;
50 getIsEvaluation: () => boolean;
51 getPixelFormat: () => "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
52 getConcurrency: () => number | null;
53 getRange: () => import("./config/frame-range").FrameRange | null;
54 getShouldOverwrite: () => boolean;
55 getOutputCodecOrUndefined: () => import("./config/codec").CodecOrUndefined;
56 getWebpackOverrideFn: () => WebpackOverrideFn;
57 getQuality: () => number | undefined;
58 getShouldOutputImageSequence: (frameRange: import("./config/frame-range").FrameRange | null) => boolean;
59 validateSelectedCrfAndCodecCombination: (crf: number, codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => void;
60 getFinalOutputCodec: ({ codec: inputCodec, fileExtension, emitWarning, }: {
61 codec: import("./config/codec").CodecOrUndefined;
62 fileExtension: string | null;
63 emitWarning: boolean;
64 }) => "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
65 useMediaVolumeState: () => readonly [number, (u: number) => void];
66 useMediaMutedState: () => readonly [boolean, (u: import("react").SetStateAction<boolean>) => void];
67 DEFAULT_CODEC: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
68 DEFAULT_PIXEL_FORMAT: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
69 FEATURE_FLAG_FIREFOX_SUPPORT: boolean;
70 DEFAULT_WEBPACK_CACHE_ENABLED: boolean;
71 getBrowser: () => import("./config/browser").Browser | null;
72 DEFAULT_BROWSER: import("./config/browser").Browser;
73 getDefaultCrfForCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => number;
74 getActualCrf: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => number;
75 setFrameRangeFromCli: (newFrameRange: string | number) => void;
76 getUserPreferredImageFormat: () => "png" | "jpeg" | "none" | undefined;
77 validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", imageFormat: "png" | "jpeg" | "none") => "none" | "valid";
78 validateSelectedPixelFormatAndCodecCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv") => void;
79 validateFrameRange: (frameRange: import("./config/frame-range").FrameRange | null) => void;
80 validateNonNullImageFormat: (imageFormat: "png" | "jpeg" | "none") => void;
81 getWebpackCaching: () => boolean;
82 useLazyComponent: <T>(compProps: CompProps<T>) => import("react").LazyExoticComponent<LooseAnyComponent<T>>;
83 truthy: typeof truthy;
84 isAudioCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | undefined) => boolean;
85 INPUT_PROPS_KEY: string;
86 Logging: typeof Logging;
87 SequenceContext: import("react").Context<import("./sequencing").SequenceContextType | null>;
88 useRemotionContexts: typeof useRemotionContexts;
89 RemotionContextProvider: (props: import("./wrap-remotion-context").RemotionContextProviderProps) => JSX.Element;
90 isPlainIndex: () => boolean;
91 CSSUtils: typeof CSSUtils;
92 setupEnvVariables: () => void;
93 setupInitialFrame: () => void;
94 ENV_VARIABLES_ENV_NAME: "ENV_VARIABLES";
95 ENV_VARIABLES_LOCAL_STORAGE_KEY: string;
96 INITIAL_FRAME_LOCAL_STORAGE_KEY: string;
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: () => "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy" | undefined;
106 setProResProfile: (profile: "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy" | undefined) => void;
107 validateSelectedCodecAndProResCombination: (actualCodec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv", actualProResProfile: "4444-xq" | "4444" | "hq" | "standard" | "light" | "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 }>;
123 validateQuality: (q: number | undefined) => void;
124 validateFrame: (frame: number, durationInFrames: number) => void;
125 setStillFrame: (frame: number) => void;
126 getStillFrame: () => number;
127 invalidCompositionErrorMessage: string;
128 isCompositionIdValid: (id: string) => RegExpMatchArray | null;
129 AssetCompression: typeof AssetCompression;
130};
131export type { TComposition, Timeline, TCompMetadata, TSequence, WebpackOverrideFn, TAsset, RenderAssetInfo, TimelineContextValue, SetTimelineContextValue, TimelineInOutContextValue, SetTimelineInOutContextValue, CompProps, CompositionManagerContext, MediaVolumeContextValue, SetMediaVolumeContextValue, LooseAnyComponent, RemotionEnvironment, ProResProfile, };
132//# sourceMappingURL=internals.d.ts.map
\No newline at end of file