Type Alias ContextType

ContextType: {
    isLoading: boolean;
    onAfterExport: OnAfterExportFunction | null;
    onBeforeExport: OnBeforeExportFunction | null;
    previewRef: React.MutableRefObject<HTMLDivElement | null> | null;
    setParams: React.Dispatch<React.SetStateAction<any>> | null;
    setTemplateUrl: React.Dispatch<React.SetStateAction<string>> | null;
    templateError: Error | null;
    videoFilePrefix: string;
    videoTemplate: VideoTemplate | null;
}

Type declaration

  • isLoading: boolean
    • A flag to indicate whether the video template is loading.
  • onAfterExport: OnAfterExportFunction | null
    • A function that's called after the video is exported.
  • onBeforeExport: OnBeforeExportFunction | null
    • A function that's called before the video is exported. Must return true for export to continue.
  • previewRef: React.MutableRefObject<HTMLDivElement | null> | null
    • A reference to the HTML div element where preview should be displayed, or null if not set.
  • setParams: React.Dispatch<React.SetStateAction<any>> | null
    • The setter function for updating the template params state variable.
  • setTemplateUrl: React.Dispatch<React.SetStateAction<string>> | null
    • The setter function for updating the template URL state variable.
  • templateError: Error | null
    • An error message related to the template, or null if no error exists.
  • videoFilePrefix: string
    • Video file prefix.
  • videoTemplate: VideoTemplate | null
    • An instance of the VideoTemplate class.

Settings

Member Visibility