module Fluorite::Docs

Overview

The Fluorite::Docs module is the authoritative technical reference and documentation guide.

Learning Tracks & Topic Index

The documentation is paced into 5 distinct tracks:

1. Getting started (A_GETTING_STARTED)

Submodule Title Description
GETTING_STARTED Getting Started with Fluorite Introduction to Fluorite modern FFMPEG library, fluent DSL, streaming runner, and interactive Opal TUI.

2. Probe (B_PROBE)

Submodule Title Description
MEDIA_PROBING Deep Media Probing and Inspection Extracting container metadata, codecs, stream specs, color spaces, and aspect ratios with ffprobe.

3. Dsl (C_DSL)

Submodule Title Description
FLUENT_DSL Fluent Block and Chainable DSL Authoring expressive FFmpeg pipelines using block-scoped and chainable Crystal builders.

4. Presets (D_PRESETS)

Submodule Title Description
CONVERSION_PRESETS Smart Conversion Presets Instant 1-line conversions for Discord file size fitting, crisp 2-pass GIFs, Web FastStart, and lossless stream cutting.

5. Tui (E_TUI)

Submodule Title Description
TUI_STUDIO Interactive Terminal Studio and Wizard Using the Opal full-screen reactive TUI and interactive CLI wizard for transcoding.

Defined in:

fluorite/docs.cr
fluorite/docs/a_getting_started/getting_started.cr
fluorite/docs/b_probe/media_probing.cr
fluorite/docs/c_dsl/fluent_dsl.cr
fluorite/docs/d_presets/conversion_presets.cr
fluorite/docs/e_tui/tui_studio.cr

Class Method Summary

Class Method Detail

def self.topic_01_quick_start : Nil #

Quick-Start Commands: Essential commands for building, running, and testing.

Fluorite FFMPEG Toolkit Commands:

fluorite tui
fluorite probe video.mp4
fluorite discord video.mp4 --limit 25MB
fluorite gif animation.mov --fps 15 --width 480
fluorite wizard

def self.topic_02_reading_paths : Nil #

Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.

Structured Learning Tracks

1. Getting started (A_GETTING_STARTED)
  • A_GETTING_STARTED::GETTING_STARTED: Getting Started with Fluorite — Introduction to Fluorite modern FFMPEG library, fluent DSL, streaming runner, and interactive Opal TUI.
2. Probe (B_PROBE)
  • B_PROBE::MEDIA_PROBING: Deep Media Probing and Inspection — Extracting container metadata, codecs, stream specs, color spaces, and aspect ratios with ffprobe.
3. Dsl (C_DSL)
  • C_DSL::FLUENT_DSL: Fluent Block and Chainable DSL — Authoring expressive FFmpeg pipelines using block-scoped and chainable Crystal builders.
4. Presets (D_PRESETS)
  • D_PRESETS::CONVERSION_PRESETS: Smart Conversion Presets — Instant 1-line conversions for Discord file size fitting, crisp 2-pass GIFs, Web FastStart, and lossless stream cutting.
5. Tui (E_TUI)
  • E_TUI::TUI_STUDIO: Interactive Terminal Studio and Wizard — Using the Opal full-screen reactive TUI and interactive CLI wizard for transcoding.

def self.topic_03_table_of_contents : Nil #

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_GETTING_STARTED
  • A_GETTING_STARTED::GETTING_STARTED: Getting Started with Fluorite — Introduction to Fluorite modern FFMPEG library, fluent DSL, streaming runner, and interactive Opal TUI.
B_PROBE
  • B_PROBE::MEDIA_PROBING: Deep Media Probing and Inspection — Extracting container metadata, codecs, stream specs, color spaces, and aspect ratios with ffprobe.
C_DSL
  • C_DSL::FLUENT_DSL: Fluent Block and Chainable DSL — Authoring expressive FFmpeg pipelines using block-scoped and chainable Crystal builders.
D_PRESETS
  • D_PRESETS::CONVERSION_PRESETS: Smart Conversion Presets — Instant 1-line conversions for Discord file size fitting, crisp 2-pass GIFs, Web FastStart, and lossless stream cutting.
E_TUI
  • E_TUI::TUI_STUDIO: Interactive Terminal Studio and Wizard — Using the Opal full-screen reactive TUI and interactive CLI wizard for transcoding.