@pixerate/editor-react 0.56.0 → 0.57.0

package/dist/video-editor/index.d.ts

@@ -1,4 +1,4 @@
-import { VideoEditorController, VideoEditorState, VideoEditResult, VideoEditorOptions, VideoEditorToolProviderOptions, VideoPreviewOptions, VideoWaveformMode, probeVideoMedia } from '@pixerate/editor/video-editor';
+import { VideoEditorController, VideoEditorState, VideoEditResult, VideoEditorOptions, VideoEditorToolProviderOptions, VideoPreviewOptions, VideoScopeKind, VideoWaveformMode, probeVideoMedia } from '@pixerate/editor/video-editor';
 import { ToolRegistry } from '@pixerate/editor/tools';
 import React__default from 'react';
 
@@ -52,6 +52,22 @@ interface VideoPreviewProps {
  */
 declare function VideoPreview({ controller, resolution, onFrame, className, style }: VideoPreviewProps): React__default.JSX.Element;
 
+interface VideoScopesProps {
+    controller: VideoEditorController;
+    /** Which scopes to show, in order (default histogram, waveform and vectorscope). */
+    scopes?: readonly VideoScopeKind[];
+    /** Size of the histogram and waveform in pixels (default 256 × 128); the vectorscope is square, `height` a side. */
+    width?: number;
+    height?: number;
+    className?: string;
+}
+/**
+ * Colour scopes of what the controller's `<VideoPreview>` draws: a histogram, a luma waveform and a
+ * vectorscope, redrawn after each frame, with exposure and clipping figures and notes. Reads the
+ * preview through `controller.previewPixels`, so it needs a preview of the same controller.
+ */
+declare function VideoScopes({ controller, scopes, width, height, className }: VideoScopesProps): React__default.JSX.Element;
+
 interface VideoTransportProps {
     controller: VideoEditorController;
     /** Show the editing buttons (split, delete, ripple delete, undo, redo; default true). */
@@ -155,6 +171,8 @@ interface VideoEditorProps {
     showIssues?: boolean;
     /** Show the transcript panel for editing by text (default true). */
     showTranscript?: boolean;
+    /** Show colour scopes (histogram, luma waveform, vectorscope) of the preview under it (default false). */
+    showScopes?: boolean;
     className?: string;
 }
 /**
@@ -162,6 +180,6 @@ interface VideoEditorProps {
  * transport, the timeline and the clip inspector, with the project's issues listed under the
  * timeline. Every edit is one undo step; the controller's agent tools edit the same project.
  */
-declare function VideoEditor({ controller: given, options, editable, pxPerSecond, onPxPerSecondChange, resolution, showIssues, showTranscript, className }: VideoEditorProps): React__default.JSX.Element;
+declare function VideoEditor({ controller: given, options, editable, pxPerSecond, onPxPerSecondChange, resolution, showIssues, showTranscript, showScopes, className }: VideoEditorProps): React__default.JSX.Element;
 
-export { ClipInspector, type ClipInspectorProps, MediaBin, type MediaBinProps, TranscriptPanel, type TranscriptPanelProps, type UseVideoEditorResult, VideoEditor, type VideoEditorProps, VideoPreview, type VideoPreviewProps, VideoTimeline, type VideoTimelineProps, VideoTransport, type VideoTransportProps, useVideoEditor, useVideoEditorController, useVideoEditorState, useVideoEditorTools };
+export { ClipInspector, type ClipInspectorProps, MediaBin, type MediaBinProps, TranscriptPanel, type TranscriptPanelProps, type UseVideoEditorResult, VideoEditor, type VideoEditorProps, VideoPreview, type VideoPreviewProps, VideoScopes, type VideoScopesProps, VideoTimeline, type VideoTimelineProps, VideoTransport, type VideoTransportProps, useVideoEditor, useVideoEditorController, useVideoEditorState, useVideoEditorTools };