clipasm 0.5.0

A strict, typed language for compiling and rendering Video and Audio graphs
Documentation
# Runnable examples

The repository's `examples/` directory contains small programs for development
and experimentation. Run the commands below from the repository root.
`validate` checks source only; `render` also requires FFmpeg and FFprobe.

For a standalone project without a repository checkout, use `clipasm init` and
follow [Get ClipAsm running](learn/01-get-clipasm-running.md).

## Example catalog

| Example | Demonstrates | Expected render | Extra requirement | Related page |
| --- | --- | --- | --- | --- |
| `examples/scenic-sequence.clipasm` | `clip`, image sources, a name, and a reference | 4.5 seconds | — | [Chapter 3: Name and reference a clip]learn/03-name-and-reference-clip.md |
| `examples/learning-journey.clipasm` | the completed learning path | 4.5 seconds | — | [Learn ClipAsm]index.md#learn-clipasm-in-order |
| `examples/crossfade.clipasm` | exact crossfade overlap | 3.5 seconds | — | [`crossfade` reference]reference/programs/crossfade.md |
| `examples/gentle-motion-edit.clipasm` | `during` and `zoom_in` | 2 seconds | — | [`during` reference]reference/programs/during.md |
| `examples/reusable-composition.clipasm` | named clips, references, and stack-bound `flash_cut` | 3 seconds | — | [Transition chapter]learn/05-transition.md |
| `examples/imported-program.clipasm` | importing a ClipAsm source program | 2 seconds | — | [Import how-to]guides/import-a-program.md |
| `examples/external-brighten.clipasm` | trusted external implementation | 2 seconds | Python 3 and a code review | [External-program guide]guides/external-programs.md |
| `examples/root-bindings.clipasm` | root Video input and required parameters | 2 seconds | CLI bindings and `--output` | [Root-bindings guide]guides/root-inputs-and-parameters.md |

## Validate or render an example

Most examples use the same two-command pattern:

```console,ignore
clipasm validate examples/scenic-sequence.clipasm
clipasm render examples/scenic-sequence.clipasm
```

Generated outputs, manifests, and caches are ignored by Git.

## Root bindings

This example requires one Video input and two scalar parameters:

```console,ignore
clipasm validate examples/root-bindings.clipasm \
  --video-input video=examples/assets/gentle-motion.mkv \
  --arg range=500ms..1500ms \
  --arg count=2

clipasm render examples/root-bindings.clipasm \
  --video-input video=examples/assets/gentle-motion.mkv \
  --arg range=500ms..1500ms \
  --arg count=2 \
  --output root-bindings.mp4
```

## External program

`examples/external-brighten.clipasm` may execute Python and FFmpeg during
rendering. Review the declaration and script before running it:

```console,ignore
clipasm validate examples/external-brighten.clipasm
clipasm inspect examples/external-brighten.clipasm
clipasm render examples/external-brighten.clipasm
```

External programs are trusted native code. Read
[Review and run an external program](guides/external-programs.md) first.