Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/ai-editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The ChatGPT and GitHub Copilot sign-in options were **removed in 1.8.0**. They w

## Using the agent

Describe the edit in plain language — "cut the dead air in the intro", "zoom in when I open the terminal". The agent works through real, undoable timeline operations, not a re-render: it can add and adjust trims, zooms, speed regions, annotations (text, arrows, and blurs that hide private details on screen), imported audio tracks with their fades, and Full Camera segments, add automatic zooms on your clicks, edit a clip's in/out points and crop, place another source's footage, duplicate, reorder or remove clips, and read the transcript to find what you're referring to. It also sets the look of the video: background, padding, rounded corners, shadow, device frame, format, the camera layout, the cursor and the master volume. It can also turn the [captions](./captions.md) on, style and place them, and translate them into another language itself.
Describe the edit in plain language — "cut the dead air in the intro", "zoom in when I open the terminal". The agent works through real, undoable timeline operations, not a re-render: it can add and adjust trims, zooms, speed regions, annotations (text, arrows, and blurs that hide private details on screen), imported audio tracks with their fades, and Full Camera segments, add automatic zooms on your clicks, edit a clip's in/out points and crop, place another source's footage, duplicate, reorder or remove clips, and read the transcript to find what you're referring to. It also sets the look of the video: background, padding, rounded corners, shadow, device frame, format, the camera layout, the cursor and the master volume. It can also turn the [captions](./captions.md) on, style and place them, and translate them into another language itself. And it can write a visual effect the settings don't offer: see [Custom effects](./effects.md).

The panel around it:

Expand Down
4 changes: 4 additions & 0 deletions website/docs/editing-timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ A row of preset buttons (0.5×, 1×, 1.5×, 2×, 4×) and a free numeric field f

A span where the webcam fills the frame instead of sitting in its layout box — useful for a talking-head intro in the middle of a screen recording. Only meaningful when the recording has a webcam track.

### Effect regions

A visual effect an AI agent wrote for the project. Its row shows under the Full Camera segments once the project has one: see [Custom effects](./effects.md#in-the-editor).

### Annotations

Four types, picked from the **Type** row in the inspector. Switching type keeps the region's span and its place in the picture.
Expand Down
64 changes: 64 additions & 0 deletions website/docs/effects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: effects
title: Custom effects
description: "Ask an AI agent for a visual effect the settings don't offer. It writes a GPU shader that OpenScreen draws in the preview and in every export."
keywords:
- custom video effects
- shader effects
- WGSL
- AI video effects
- GPU effects
---

# Custom effects

When the settings don't have the look you want, ask an agent for it: a ripple from each click, a vignette that breathes, a fade to black over the last seconds. The agent writes the effect as a small GPU shader, and OpenScreen draws it in the preview and in every export, MP4 and GIF, on Windows, macOS and Linux.

Effects come from an agent: the built-in chat or an MCP client such as Claude Code or Codex (see [AI editing](./ai-editing.md)). Once an effect is in the project, you adjust it yourself in the editor.

## Asking for an effect

Describe what you want to see, and when: "a ripple on every click", "fade to black over the last two seconds, captions included". The agent writes the effect, places it on the timeline, and can look at the result with `getFrames` without exporting the video.

An effect knows where the cursor is and where each click landed, where the recording and the webcam sit in the video after zooms and layout, and the time. So a halo can follow the mouse, and a ripple can start from each click, wherever the zoom has moved it.

## In the editor

Effects get their own row on the timeline, under the Full Camera segments, once the project has one. Each block carries the effect's name. Move it, resize it, copy and paste it or delete it like any other region, and `Ctrl/Cmd + Z` undoes the change. One effect plays at a time: a paste onto another effect is refused.

Click a block to open its inspector:

- **A control for each setting** the agent gave the effect: a slider, a switch, a color or a point.
- **Applies to**, where the effect is drawn:
- **Image**, the default: the recording, the webcam, the cursor and the background, under your annotations and captions, which stay legible.
- **Text**: the annotations and captions only.
- **Both**: the whole frame, text included, for a fade to black that also covers the captions.
- **Cost**: **Light**, **Medium**, **Heavy** or **Very heavy** (see [below](#cost)).
- **Code**: the shader, read-only, with **Copy code**. To change it, ask the agent.

A copied effect pasted into another project brings its code along.

## Cost

The cost is estimated from the code, by counting how many times the effect reads the picture for each pixel. The same code gets the same tier on every computer. Nothing is refused for its cost: the heavier the effect, the shorter the stretch it suits.

| Tier | Typical effects | Suits |
|---|---|---|
| **Light** | vignette, color grade, click ripple | the whole video |
| **Medium** | chromatic aberration, small blur, glitch | a few tens of seconds |
| **Heavy** | strong blur, bokeh | a transition, a highlight |
| **Very heavy** | raymarching, simulations | a few seconds: the export stays exact but slower, and the preview can slow down on a small GPU |

## If an effect doesn't compile

An agent's code is compiled before the effect is accepted. Code that fails is refused with the compiler's error, and the project doesn't change.

A project opened on another computer can still meet a compiler that disagrees. The effect is then not drawn, its inspector shows **Doesn't compile on this computer** with the error, and the export goes on without it.

## Projects from someone else

A project carries the code of its effects, so opening someone else's project runs code you didn't write. That code runs only on the GPU, with no access to your files, the network or the app's memory.

## For agent authors

The tools are `addEffect`, `setEffect`, `setEffectDefinition` and `getEffect`, and `removeModifier` takes an effect off. The full contract, the `effect(uv)` function, what it can read and its rules, is the MCP resource `openscreen://effects/contract`.
4 changes: 2 additions & 2 deletions website/i18n/TRANSLATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Replace `<locale>` with `fr`, `es`, `pt-BR`, `ja`, `zh-CN`, `zh-TW` or `de`.
3. **`i18n/<locale>/docusaurus-plugin-content-docs/current.json`**: sidebar category and link labels. `version.label` is not shown.
4. **`i18n/<locale>/docusaurus-plugin-content-docs/current/`**: one translated copy of each doc, same file name and folder:
- `intro.md`, `installation.md`, `quick-start.md`, `faq.md`
- `recording.md`, `media-library.md`, `editing-timeline.md`, `captions.md`, `ai-editing.md`, `export.md`, `cli.md`
- `recording.md`, `media-library.md`, `editing-timeline.md`, `captions.md`, `ai-editing.md`, `effects.md`, `export.md`, `cli.md`
- `guides/product-demo-video.md`

Start from a copy of `website/docs/<file>`. In the front matter, translate `title`, `description`, `sidebar_label` and `keywords`. Leave `id`, `slug` and `sidebar_position` as they are.
5. **`i18n/<locale>/docusaurus-plugin-content-pages/`**: one translated copy of each `website/src/pages/**/*.mdx`, same path (`alternatives/screen-studio.mdx`, `screen-recorder-linux.mdx`…). Translate `title`, `description` and `keywords` in the front matter. Prices, plan limits and "checked September 2026" dates are facts: copy them as they are, in your language's number and currency format. Keep the Sources list's URLs, and translate the trademark note.

**All 12 docs of a locale land together.** The docs link to each other with relative paths (`./captions.md`), and Docusaurus only resolves those between files in the same folder: with some docs translated and others not, the build fails on broken links. A doc missing from a finished locale would also be published under `/<locale>/docs/` in English, marked as your language.
**All 13 docs of a locale land together.** The docs link to each other with relative paths (`./captions.md`), and Docusaurus only resolves those between files in the same folder: with some docs translated and others not, the build fails on broken links. A doc missing from a finished locale would also be published under `/<locale>/docs/` in English, marked as your language.

## Keep every heading's English anchor

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Die Anmeldeoptionen für ChatGPT und GitHub Copilot wurden **in 1.8.0 entfernt**

## Den Agenten nutzen {#using-the-agent}

Beschreibe die Änderung in Alltagssprache, etwa „schneide die Stille im Intro heraus“ oder „zoome hinein, wenn ich das Terminal öffne“. Der Agent arbeitet mit echten, rückgängig machbaren Operationen auf der Zeitleiste, nicht mit einem neuen Rendering: Er kann Schnitte, Zooms, Geschwindigkeitsbereiche, Annotationen (Text, Pfeile und Unschärfen, die private Details auf dem Bildschirm verbergen), importierte Audiospuren samt Ein- und Ausblendung und Full-Camera-Segmente hinzufügen und anpassen, automatische Zooms auf deine Klicks setzen, Start- und Endpunkte und den Zuschnitt eines Clips ändern, Material einer anderen Quelle platzieren, Clips duplizieren, umsortieren oder entfernen und das Transkript lesen, um herauszufinden, was du meinst. Außerdem stellt er das Aussehen des Videos ein: Hintergrund, Innenabstand, abgerundete Ecken, Schatten, Geräterahmen, Format, das Kamera-Layout, den Cursor und die Gesamtlautstärke. Er kann außerdem die [Untertitel](./captions.md) einschalten, gestalten und platzieren und sie selbst in eine andere Sprache übersetzen.
Beschreibe die Änderung in Alltagssprache, etwa „schneide die Stille im Intro heraus“ oder „zoome hinein, wenn ich das Terminal öffne“. Der Agent arbeitet mit echten, rückgängig machbaren Operationen auf der Zeitleiste, nicht mit einem neuen Rendering: Er kann Schnitte, Zooms, Geschwindigkeitsbereiche, Annotationen (Text, Pfeile und Unschärfen, die private Details auf dem Bildschirm verbergen), importierte Audiospuren samt Ein- und Ausblendung und Full-Camera-Segmente hinzufügen und anpassen, automatische Zooms auf deine Klicks setzen, Start- und Endpunkte und den Zuschnitt eines Clips ändern, Material einer anderen Quelle platzieren, Clips duplizieren, umsortieren oder entfernen und das Transkript lesen, um herauszufinden, was du meinst. Außerdem stellt er das Aussehen des Videos ein: Hintergrund, Innenabstand, abgerundete Ecken, Schatten, Geräterahmen, Format, das Kamera-Layout, den Cursor und die Gesamtlautstärke. Er kann außerdem die [Untertitel](./captions.md) einschalten, gestalten und platzieren und sie selbst in eine andere Sprache übersetzen. Und er kann einen visuellen Effekt schreiben, den die Einstellungen nicht bieten: siehe [Eigene Effekte](./effects.md).

Der Bereich drumherum:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ Eine Reihe von Vorgabe-Schaltflächen (0.5×, 1×, 1.5×, 2×, 4×) und ein frei

Ein Abschnitt, in dem die Webcam das Bild füllt, statt in ihrem Layout-Rahmen zu sitzen. Praktisch für ein Intro mit dir vor der Kamera mitten in einer Bildschirmaufnahme. Nur sinnvoll, wenn die Aufnahme eine Webcam-Spur hat.

### Effektbereiche {#effect-regions}

Ein visueller Effekt, den ein KI-Agent für das Projekt geschrieben hat. Seine Reihe erscheint unter den Full-Camera-Segmenten, sobald das Projekt einen enthält: siehe [Eigene Effekte](./effects.md#in-the-editor).

### Annotationen {#annotations}

Vier Arten, wählbar in der Zeile **Type** im Inspektor. Beim Umschalten bleiben die Zeitspanne des Bereichs und seine Stelle im Bild erhalten.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: effects
title: Eigene Effekte
description: "Bitte einen KI-Agenten um einen visuellen Effekt, den die Einstellungen nicht bieten. Er schreibt einen GPU-Shader, den OpenScreen in der Vorschau und in jedem Export zeichnet."
keywords:
- eigene Videoeffekte
- Shader-Effekte
- WGSL
- KI-Videoeffekte
- GPU-Effekte
---

# Eigene Effekte

Wenn die Einstellungen den Look nicht haben, den du suchst, bitte einen Agenten darum: eine Welle bei jedem Klick, eine Vignette, die atmet, eine Abblende ins Schwarze in den letzten Sekunden. Der Agent schreibt den Effekt als kleinen GPU-Shader, und OpenScreen zeichnet ihn in der Vorschau und in jedem Export, MP4 wie GIF, unter Windows, macOS und Linux.

Effekte kommen von einem Agenten: dem eingebauten Chat oder einem MCP-Client wie Claude Code oder Codex (siehe [KI-Bearbeitung](./ai-editing.md)). Sobald ein Effekt im Projekt ist, stellst du ihn selbst im Editor ein.

## Einen Effekt anfragen {#asking-for-an-effect}

Beschreibe, was du sehen willst, und wann: „eine Welle bei jedem Klick“, „Abblende ins Schwarze über die letzten zwei Sekunden, Untertitel inklusive“. Der Agent schreibt den Effekt, legt ihn auf die Zeitleiste und kann sich das Ergebnis mit `getFrames` ansehen, ohne das Video zu exportieren.

Ein Effekt weiß, wo der Cursor ist und wo jeder Klick gelandet ist, wo die Aufnahme und die Webcam nach Zooms und Layout im Video sitzen, und welcher Zeitpunkt gerade ist. So kann ein Lichthof der Maus folgen, und eine Welle kann von jedem Klick ausgehen, wohin der Zoom ihn auch verschoben hat.

## Im Editor {#in-the-editor}

Effekte bekommen eine eigene Reihe auf der Zeitleiste, unter den Full-Camera-Segmenten, sobald das Projekt einen enthält. Jeder Block trägt den Namen des Effekts. Verschiebe ihn, ändere seine Größe, kopiere und füge ihn ein oder lösche ihn wie jeden anderen Bereich, und `Ctrl/Cmd + Z` macht die Änderung rückgängig. Es läuft immer nur ein Effekt: Einfügen auf einen anderen Effekt wird abgelehnt.

Klicke auf einen Block, um seinen Inspektor zu öffnen:

- **Ein Regler für jede Einstellung**, die der Agent dem Effekt gegeben hat: ein Schieberegler, ein Schalter, eine Farbe oder ein Punkt.
- **Gilt für**, also wo der Effekt gezeichnet wird:
- **Bild**, die Voreinstellung: die Aufnahme, die Webcam, der Cursor und der Hintergrund, unter deinen Annotationen und Untertiteln, die lesbar bleiben.
- **Texte**: nur die Annotationen und Untertitel.
- **Beides**: das ganze Bild, Text inklusive, für eine Abblende ins Schwarze, die auch die Untertitel bedeckt.
- **Kosten**: **Leicht**, **Mittel**, **Schwer** oder **Sehr schwer** (siehe [unten](#cost)).
- **Code**: der Shader, schreibgeschützt, mit **Code kopieren**. Um ihn zu ändern, bitte den Agenten darum.

Ein kopierter Effekt, der in ein anderes Projekt eingefügt wird, bringt seinen Code mit.

## Kosten {#cost}

Die Kosten werden aus dem Code geschätzt: Gezählt wird, wie oft der Effekt das Bild pro Pixel liest. Derselbe Code bekommt auf jedem Computer dieselbe Stufe. Nichts wird wegen seiner Kosten abgelehnt: Je schwerer der Effekt, desto kürzer der Abschnitt, der zu ihm passt.

| Stufe | Typische Effekte | Passt für |
|---|---|---|
| **Leicht** | Vignette, Farbkorrektur, Welle beim Klick | das ganze Video |
| **Mittel** | chromatische Aberration, leichte Unschärfe, Glitch | einige Dutzend Sekunden |
| **Schwer** | starke Unschärfe, Bokeh | einen Übergang, einen Höhepunkt |
| **Sehr schwer** | Raymarching, Simulationen | wenige Sekunden: Der Export bleibt exakt, aber langsamer, und die Vorschau kann auf einer kleinen GPU langsamer werden |

## Wenn ein Effekt nicht kompiliert {#if-an-effect-doesnt-compile}

Der Code eines Agenten wird kompiliert, bevor der Effekt angenommen wird. Code, der scheitert, wird mit dem Fehler des Compilers abgelehnt, und das Projekt ändert sich nicht.

Ein Projekt, das auf einem anderen Computer geöffnet wird, kann trotzdem auf einen Compiler treffen, der anderer Meinung ist. Der Effekt wird dann nicht gezeichnet, sein Inspektor zeigt **Lässt sich auf diesem Computer nicht kompilieren** mit dem Fehler, und der Export läuft ohne ihn weiter.

## Projekte von anderen {#projects-from-someone-else}

Ein Projekt trägt den Code seiner Effekte: Öffnest du das Projekt eines anderen, führst du also Code aus, den du nicht geschrieben hast. Dieser Code läuft nur auf der GPU, ohne Zugriff auf deine Dateien, das Netzwerk oder den Speicher der App.

## Für Agent-Entwickler {#for-agent-authors}

Die Werkzeuge sind `addEffect`, `setEffect`, `setEffectDefinition` und `getEffect`, und `removeModifier` entfernt einen Effekt. Der vollständige Vertrag, also die Funktion `effect(uv)`, was sie lesen kann und ihre Regeln, ist die MCP-Ressource `openscreen://effects/contract`.
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Las opciones de inicio de sesión con ChatGPT y GitHub Copilot se **eliminaron e

## Usar el agente {#using-the-agent}

Describe la edición con tus propias palabras: "corta el tiempo muerto de la introducción", "haz zoom cuando abro la terminal". El agente trabaja con operaciones reales de la línea de tiempo, que se pueden deshacer, y no con un nuevo renderizado: puede agregar y ajustar recortes, zooms, regiones de velocidad, anotaciones (texto, flechas y desenfoques que ocultan datos privados en pantalla), pistas de audio importadas con sus fundidos y segmentos de cámara a pantalla completa, agregar zooms automáticos en tus clics, editar los puntos de entrada y salida y el recorte de un clip, colocar el material de otra fuente, duplicar, reordenar o quitar clips, y leer la transcripción para encontrar aquello a lo que te refieres. También ajusta el aspecto del vídeo: fondo, margen, esquinas redondeadas, sombra, marco de dispositivo, formato, la disposición de la cámara, el cursor y el volumen general. También puede activar los [subtítulos](./captions.md), darles estilo y colocarlos, y traducirlos él mismo a otro idioma.
Describe la edición con tus propias palabras: "corta el tiempo muerto de la introducción", "haz zoom cuando abro la terminal". El agente trabaja con operaciones reales de la línea de tiempo, que se pueden deshacer, y no con un nuevo renderizado: puede agregar y ajustar recortes, zooms, regiones de velocidad, anotaciones (texto, flechas y desenfoques que ocultan datos privados en pantalla), pistas de audio importadas con sus fundidos y segmentos de cámara a pantalla completa, agregar zooms automáticos en tus clics, editar los puntos de entrada y salida y el recorte de un clip, colocar el material de otra fuente, duplicar, reordenar o quitar clips, y leer la transcripción para encontrar aquello a lo que te refieres. También ajusta el aspecto del vídeo: fondo, margen, esquinas redondeadas, sombra, marco de dispositivo, formato, la disposición de la cámara, el cursor y el volumen general. También puede activar los [subtítulos](./captions.md), darles estilo y colocarlos, y traducirlos él mismo a otro idioma. Y puede escribir un efecto visual que los ajustes no ofrecen: consulta [Efectos personalizados](./effects.md).

El panel que lo rodea:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ Una fila de botones predefinidos (0.5×, 1×, 1.5×, 2×, 4×) y un campo numér

Un tramo en el que la cámara web llena el cuadro en lugar de ocupar su recuadro de la disposición: útil para una introducción hablando a cámara en medio de una grabación de pantalla. Solo tiene sentido cuando la grabación tiene una pista de cámara web.

### Regiones de efecto {#effect-regions}

Un efecto visual que un agente de IA escribió para el proyecto. Su fila aparece bajo los tramos de cámara a pantalla completa en cuanto el proyecto tiene uno: consulta [Efectos personalizados](./effects.md#in-the-editor).

### Anotaciones {#annotations}

Cuatro tipos, que se eligen en la fila **Tipo** del inspector. Cambiar de tipo conserva el tramo de la región y su lugar en la imagen.
Expand Down
Loading
Loading