pro_video_editor library

Classes

AudioDucking
Lowers a track while someone talks on other tracks, and brings it back up when they stop: the classic ducking of music under a voice-over.
AudioEqualizer
Raises or lowers parts of a clip's or a track's audio with a list of bands, each a low shelf, a peak or a high shelf.
AudioEqualizerBand
One filter of an AudioEqualizer: a shelf or a peak at frequency that raises or lowers the audio by gain decibels.
AudioExtractConfigs
Configuration for extracting audio from a video.
AudioLevelEnvelope
How loud a set of audio tracks is over the exported video: the highest peak level among them, levelsPerSecond times a second from its start.
AudioMergeConfigs
Configuration for merging the audio of several trimmed clip windows into a single, seamlessly concatenated audio file.
AudioMergeResult
The result of a mergeAudioToFile call.
AudioMergeSegment
A single trimmed audio window that participates in an audio merge.
AudioMergeSegmentOffset
Where a single input segment ended up in a merged audio file.
AudioVisualizerPainter
Paints a LayerAudioVisualizer in a box, the shapes the export draws.
AudioVolumeCurve
A volume that changes over time on the exported video, moving in a straight line from one of its points to the next.
AudioVolumePoint
One point of an AudioVolumeCurve: the volume at time.
AudioWaveform
A widget that displays an audio waveform visualization.
ChromaKey
Removes a solid-colored background (a "green screen") from the video.
ChromaKeyDetection
What ChromaKeyDetector read out of a frame.
ChromaKeyDetector
Reads the screen color and its spread out of a frame.
ClipTransition
A transition played at the boundary between one VideoSegment and the next.
ColorFilter
A model representing a color filter with timing information.
CustomVideoEffect
A video effect the app implements itself, in native code it registers with the plugin under id.
EditorLayerImage
A model that encapsulates various ways to load and represent an image.
EditorVideo
A model that encapsulates various ways to load and represent a video.
ExportTransform
Represents a set of transformations to apply during video export.
GpsCoordinates
Represents GPS coordinates with latitude and longitude.
ImageLayer
A model representing a video overlay layer with timing information.
ImageLayerFrame
One image of an ImageLayer.frames sequence and how long it shows.
KeyframeClockPoint
One point of the clock a layer's keyframes are timed on: the layer is at keyframe on that clock when the video is at output.
KeyFramesConfigs
Configuration model for extracting key frames from a video.
LayerAnimation
A single animation applied to an ImageLayer.
LayerAudioVisualizer
Turns an ImageLayer into an audio visualizer: bars or a wave that move with the sound, drawn in the layer's box instead of its image.
LayerCensor
Turns an ImageLayer into an area that blurs or pixelates the picture beneath it, e.g. to hide a face, a license plate or a message on a screen.
LayerShapeMask
A shape a layer shows through, drawn by the renderer on every frame, so it can move, grow, turn and soften over time on its own (see keyframes).
LayerShapeMaskKeyframe
Where a LayerShapeMask's shape is, how big it is, how far it is turned and how soft its edge is at one point of the layer's keyframe timeline.
LumaFrame
One decoded frame as raw 8-bit luma, emitted by ProVideoEditor.getLumaFrameStream.
LumaFrameConfigs
Configuration for streaming every frame of a video range as raw luma.
NativeFailureDetails
What the platform reported behind a failed job's PlatformException.
NativeLogEntry
A single log entry forwarded from the native plugin implementation.
NativeSourceFormat
The video format of one or more sources of a failed render.
ObjectTrackSample
Where a tracked object is in one frame.
ProgressModel
Model representing a progress update.
ProVideoEditor
Abstract platform interface for the Pro Video Editor plugin.
SegmentKeyframe
Where a segment's picture is moved, how far it is zoomed and how far it is turned at one frame of its source video.
SegmentTransform
Describes how a video segment is positioned and scaled within the composition canvas.
SingleThumbnailConfigs
Configuration model for extracting a single thumbnail from a video.
SplitVideoModel
Configuration for a frame-accurate video split.
StabilizationKeyframe
How one source frame is moved to steady the shot.
StopMotionFrame
A single still image used as one frame of a stop-motion video.
StopMotionRenderData
A model describing settings for rendering a stop-motion video from a sequence of still images.
ThumbnailConfigs
Configuration model for generating video thumbnails.
ThumbnailFrame
One decoded frame delivered by ProVideoEditor.getThumbnailStream.
TimelineKeyframe
Where a layer is, how big it is, how far it is turned and how opaque it is at one point of the video's timeline.
VideoAudioTrack
A model representing an audio track with timing information.
VideoComposition
A multi-layer video composition.
VideoEffect
A visual effect that distorts the picture itself, unlike a ColorFilter, which only changes colors.
VideoEffectBand
A horizontal slice of the frame that is shifted sideways.
VideoEffectFrame
The pixel operations a VideoEffect applies to one frame.
VideoEffectPreview
Shows child with effects applied, the way an export renders them.
VideoLayer
A single layer (track) within a VideoComposition.
VideoLoopPoint
Where to cut a video so that it loops without a visible jump, found by VideoLoopPointFinder.
VideoLoopPointFinder
Finds where to cut a video so that it loops without a visible jump.
VideoMetadata
A class that holds metadata information about a video.
VideoObjectTrack
The path an object takes through a video, found by VideoObjectTracker.
VideoObjectTracker
Follows an object through a sequence of frames.
VideoQualityConfig
Configuration class that defines video quality parameters.
VideoRenderData
A model describing settings for rendering or exporting a video.
VideoSegment
Represents a single video clip to be included in a video composition.
VideoSpeedRamp
A speed that changes while a VideoSegment plays, for example fast into a jump, slow motion on its peak and fast again on the landing.
VideoSpeedRampPoint
One speed a VideoSpeedRamp passes through.
VideoSpeedRampStep
A stretch of a segment that a VideoSpeedRamp plays at one speed.
VideoStabilization
A per-frame transform that steadies a shaky video.
VideoStabilizationAnalyzer
Measures camera shake in a sequence of frames and plans the transforms that steady it.
WaveformChunk
Represents a chunk of waveform data received during streaming.
WaveformConfigs
Configuration for waveform generation.
WaveformData
Represents waveform data extracted from an audio source.
WaveformStyle
Visual styling options for AudioWaveform.

Enums

AnimationCurve
Easing curve for animation timing.
AnimationPhase
Whether the animation plays at the start, end, or both ends of the layer's time range, or repeats throughout it.
AudioEqualizerBandType
The shape of an AudioEqualizerBand's filter.
AudioFormat
Audio output formats supported for audio extraction.
AudioVisualizerStyle
How a LayerAudioVisualizer draws the levels of its bands.
ClipTransitionDirection
Direction for directional transitions (ClipTransitionType.slide, ClipTransitionType.push, ClipTransitionType.wipe, ClipTransitionType.whipPan, ClipTransitionType.stretch, ClipTransitionType.diagonalWipe, ClipTransitionType.flip, ClipTransitionType.cube); see ClipTransitionType.usesDirection.
ClipTransitionType
The type of transition to play between two adjacent video clips.
EditorImageType
Enum representing the type of source the image was loaded from.
EditorVideoType
Enum representing the type of source the video was loaded from.
FlipAxis
The axis a LayerAnimationType.flip turns a layer around.
LayerAnimationType
The type of animation to apply to an image layer.
LayerBlendMode
How a layer's pixels combine with the picture beneath it.
LayerCensorType
How a censor ImageLayer hides the picture beneath it.
LayerShapeMaskShape
The shape a LayerShapeMask lets its layer show through.
NativeLogLevel
Controls how much native logging the plugin emits on supported platforms.
RenderCodecKind
The kind of codec a RenderEncoderException could not bring up.
SegmentFit
Defines how a video segment's source frame is scaled into its target SegmentTransform.size.
SlideDirection
Slide direction for slide animations.
StopMotionFit
Describes how a single frame is mapped onto the output video size when its aspect ratio differs from the target resolution.
ThumbnailBoxFit
Defines how the video content should be fit within the thumbnail bounds.
ThumbnailFormat
Supported image formats for video thumbnails.
ThumbnailPosition
Position from which to extract a single thumbnail.
VideoEffectType
The look a VideoEffect gives the video.
VideoOutputFormat
Supported video output formats for export.
VideoQualityPreset
Pre-defined video quality presets for common export scenarios.
WaveformResolution
Resolution presets for waveform generation.

Mixins

TimeRangeMixin
A mixin that provides optional start and end time fields for timeline-based elements.

Functions

fetchVideoAsUint8List(String videoUrl) → Future<Uint8List>
Fetches an video from a network URL as a Uint8List.
fetchVideoToFile(String videoUrl, String filePath) → Future<File>
Fetches a video from a given URL and saves it to a specified file path.
loadAssetVideoAsUint8List(String assetPath) → Future<Uint8List>
Loads an video asset as a Uint8List.
readFileAsUint8List(File file) → Future<Uint8List>
Reads a file as a Uint8List.
writeAssetVideoToFile(String assetPath, String filePath) → Future<File>
Writes a video asset to a file on the local file system.
writeMemoryVideoToFile(Uint8List bytes, String filePath) → Future<File>
Writes a video file from memory to the specified file path.

Exceptions / Errors

AudioNoTrackException
Exceptions thrown when no audio is found.
ChromaKeyDetectionException
Thrown when a frame does not contain a usable screen.
RenderCanceledException
Exceptions thrown during render operations.
RenderEncoderException
Thrown when the video could not be exported because a video codec refused the export.