The whole public surface on one page. Everything here works today. Preview and
render a composition file:
fluvie preview ./lib/my_video.dart # live, hot-reloading
fluvie render ./lib/my_video.dart --out my_video.mp4 # the file
From a clone of this repo, render a lesson by its key, because the gallery keeps
a registry:
dart run packages/fluvie_cli/bin/fluvie.dart render 01_hello_video --out build/01_hello_video.mp4
| Literal | Meaning |
|---|
18.frames | absolute frames |
4.seconds, 300.ms | absolute time, resolved at the video’s fps |
0.3.relative | 30 percent of the enclosing window |
Time.zero | frame 0 |
4.seconds.to(7.seconds) | a TimeRange (trims, windows) |
| Surface | Notes |
|---|
Video(size:, fps:, scenes:, motionDefaults:, poster:, audio:, captions:, export:, transition:) | the root |
Scene(duration:, children:, background:, motionDefaults:, audio:, camera:) | one segment; children sit on a centered stack |
Scene.centered(duration:, child:) | one-child convenience |
Scene.sequence(timeline:, children:) | duration from a TimelineSchedule |
VideoSize.square / reels / story / hd / fourK | canvas presets; story aliases reels |
Transition.cut / crossFade / wipe / zoom / slide | between-scene transitions |
Every preset, with exactly what it does and its defaults, is in
Animation presets.
| Surface | Notes |
|---|
widget.animate([...], anchor:, window:, defaults:) | attach animations to any widget |
widget.show(from:, to:) | bound an element to a window |
Animation.fadeIn / fadeOut | opacity |
Animation.slideIn / slideOut / slideFadeIn / slideFadeOut | offset, optionally with fade |
Animation.pop / scaleIn / scaleOut | springy scale |
Animation.blurIn / blurOut | blur |
Animation.color(to:) | color lerp, consumed by color-capable elements |
Animation.gradientShift(to:) | pairwise gradient lerp |
Animation.maskWipeIn(shape:) / maskWipeOut(shape:) | reveal or hide with a wipe |
Animation.float / pulse / drift / spin / kenBurns | ambient loops |
Animation.from / to / fromTo / keyframes / along / custom | build your own |
Stagger.each(time) / evenly(over:) / from(origin) | offset multi-child targets |
Repeat.forever(yoyo:) / times(n, gap:) | loop inside the span |
Defaults(duration:, ease:, stagger:) | cascade: element over scene over video over package |
Spring.gentle / snappy / bouncy / stiff, Ease.smooth / out / snappy / … | timing feel |
| Surface | Notes |
|---|
Animation.grain / vignette / scanlines / chromatic / bloom / glitchIn / glitchOut | post-process the rendered frame |
Animation.particles(spec) | deterministic field; build with Particles.confetti / snow / sparkle |
Animation.parallax(depth:) | scene-clock drift for parallax layers |
Animation.shader(asset, uniforms:) | experimental fragment shader over the element |
| Surface | Notes |
|---|
Text(...).animate([...]) | plain Flutter text plus motion |
Typewriter(text, speed:, caret:) | frame-driven per-glyph reveal |
Counter(to:, from:, reveal:, format:) | frame-driven number tween, intl-formatted |
Counter.currency / percent | fixed-locale money and percentage presets |
Image.asset / file / memory / network(url, fit:, frame:, shared:) | a still, pre-resolved before frame 0 |
Clip.asset / network(url, trim:, audio:, fit:, shared:) | an embedded video |
ClipAudio.included / muted | a clip’s audio policy |
Chart.bar / line / area / pie / donut / scatter | data-driven charts that reveal from your data |
Bars(...) | a standalone bar set |
Code(...) / CodeReveal(...) | highlighted, typed code |
Terminal(...) / TerminalChrome / TerminalLine | an animated terminal session |
Markdown(...) | rendered Markdown |
| Surface | Notes |
|---|
Arrow / Connector / Callout | pointers and labels |
Spotlight / Shape / LowerThird / TitleCard | emphasis and titles |
| Surface | Notes |
|---|
Snapshot(...) / DeviceFrame(...) | a Flutter subtree rasterized once in-process, painted every frame (no service needed) |
Mermaid(...) / MermaidReveal(...) | a diagram rasterized once (experimental, needs a SnapshotService) |
WebView(...) / Html(...) | a web page or HTML rasterized once (experimental, needs a SnapshotService) |
| Surface | Notes |
|---|
Trigger.auto | the phase default |
Trigger.at(time) | explicit time in the window |
Trigger.whenEnds(a) / Trigger.whenStarts(a) | react to an Anchor |
Trigger.previous | chain off the previous animation |
Trigger.sceneStart / Trigger.sceneEnd | scene boundaries |
Trigger.beat(every:, track:) | on the analysed beat grid of an audio track |
| Surface | Notes |
|---|
Background.color / gradient / radial / noise / vhs | painted fills |
Background.image / video | pre-resolved like Image/Clip |
Box(color:, size:) | fractional-size rectangle; null size fills |
PhotoFrame.none / rounded / card / polaroid | styled wrappers |
FadeBox(opacity:, child:) (package:fluvie/rendering.dart) | render-safe opacity primitive |
| Surface | Notes |
|---|
Audio.music(source, volume:, fadeIn:, fadeOut:, loop:, trim:, track:) | a music bed mixed under the frames |
Audio.sfx(source, at:, volume:) | a one-shot effect fired at a trigger |
Animation.pulse(on: AudioBand.bass) / scaleY(on:) | reactive motion, analysed before frame 0 |
Captions.fromSrt / fromVtt / words | subtitle sources |
CaptionStyle.subtitle / tikTok / karaoke, CaptionPosition.bottomThird / topThird / center / custom | look and placement |
| Surface | Notes |
|---|
FluvieTheme(palette:, type:, motion:, child:) | brand a subtree |
Palette(bg:, accent:, onBg:, …), TypeScale.fromBase(base, ratio:) | the tokens |
context.fluvie.brand / type | read tokens at the call site |
Adaptive(reels:, square:, landscape:, portrait45:) | branch layout per aspect |
Aspect.reels / square / landscape / portrait45 | aspect families |
render(video, aspect:) (package:fluvie/rendering.dart) | render one definition for one aspect |
| Surface | Notes |
|---|
VideoTemplate | a pure function of props, rendered per data row |
TitleIntro / TitleIntroProps, StatHighlight / StatHighlightProps | built-in templates |
renderTemplate(template, props) (package:fluvie/rendering.dart) | render one props row |
| Surface | Notes |
|---|
Export.mp4(quality:) | H.264 MP4; Quality.low / medium / high / max |
Export.gif(fps:) | animated GIF |
Export.imageSequence() | one PNG per frame |
Export.transparent() | WebM with an alpha channel |
| Command | Notes |
|---|
fluvie init [--name] [--dir] [--force] | scaffold a project: a composition file, assets/, a pubspec |
fluvie preview <file.dart> [-d <device>] | live preview with hot reload; defaults to this desktop |
fluvie render <file.dart> --out <file> | capture and encode; --entry, --cache, --aspect, --quality, --format, --poster, --frames |
fluvie render <key> --out <file> | the legacy registry path; --no-cache bypasses the cache |
fluvie list | the render keys of a project that still uses a registry |
fluvie ffmpeg <install|path|status|uninstall> | manage the FFmpeg build Fluvie downloads |
A composition file exposes a top-level Video build(); --entry <name> names
another.
| Surface | Notes |
|---|
renderVideo(video:, outDir:, pumpWidget:, pumpFrame:, setViewSize:) (package:fluvie/rendering.dart) | the one capture entry a host drives; derives geometry, media, audio, captions from the Video |
runAsyncDirectly, SetViewSize, ShellRunAsync | the host seams renderVideo takes |
parseAspect / parseQuality / parseExportFormat / parsePosterTime | CLI define strings to typed arguments |
writeRenderProgress(file, completed, total) | the progress file a supervising process polls |
| Surface | Notes |
|---|
FrameBuilder((ctx) => …) | experimental frame-clock builder when no preset fits |
Timeline() (experimental) | GSAP-style builder; play / playAll / wait / label, at: takes a Trigger / label |
TimelineProbe + TimelineProbeScope | mount above a Video to receive its ResolvedTimeline |
debugTimeline(timeline) | a fixed-width text table of every animation |
InspectorModel.fromTimeline(...) | the inspector’s value model: motions, anchors, warnings |
printVideoSpecJson(Map) (package:fluvie_cli, experimental) | turn a VideoSpec into an editable Video build() snippet; pure, no model, no render |
