Build for Yrendr 1.1

Getting Started

Plugin API overview The host/plugin boundary, supported extension types and the rules that keep preview, export and project persistence predictable. Security model Understand why Yrendr plugins are trusted Python code and why capabilities are metadata rather than a sandbox. Package layout Structure a plugin directory or ZIP so Plugin Manager can discover and install it reliably. plugin.json manifest Reference for plugin package metadata, stable package IDs, entrypoints and initial enable state. Entrypoint and register(api) Implement register(api) and use the current effect metadata surface, bypass predicates, conditional time dependency and timeline processor registration. Compatibility with Yrendr 1.1 What changes for existing 1.0 plugins in Yrendr 1.1.

Parameters & UI

Parameters and native controls Declare stable parameter keys and use Yrendr-owned sliders, knobs, toggles, choices, XY pads, curves, EQ controls and file pickers. Presets and randomizers Ship meaningful parameter presets and expose host-owned Randomize behavior without breaking declared parameter constraints. Custom editors and plugin windows Build responsive custom editors with host-owned sizing, borders, window controls, singleton behavior and custom title-bar action hitboxes.

Effects & Generators

Video effects Register frame processors, return valid RGB arrays and use context, clip_types and time-dependency flags correctly. Audio effects Process normalized float32 audio while preserving frame/channel shape and behaving correctly on bounded preview chunks. Procedural generators Generate RGB/RGBA visual sources and consume Yrendr audio-analysis values for music-reactive visuals. FX routing and persistence Understand track/Master ordering, effect instance persistence and missing-plugin behavior.

Timeline Processors

Timeline processor API Run analysis/editing work on a detached snapshot and return validated actions instead of mutating the live project. Processor progress Report bounded progress and status messages from long-running worker-thread timeline processors. Processor result format Return actions, outputs and user-facing messages in the host-normalized processor result format. Timeline actions Reference for create/update tracks, create/update/move/trim/split/delete clips and set_keyframes actions. Processor outputs Create reusable Project Viewer assets from existing files, generated content, archive members and in-memory content. Editor-owned rendering Request video, still-frame or source-copy rendering through runtime render_media without importing the renderer directly.

Runtime & Performance

Failure isolation and missing plugins Understand package failures, skipped processor calls, invalid outputs and rollback behavior. Performance guidelines Keep frame/audio processors hot-path friendly with caching, vectorization, early exits and accurate time-dependency metadata.

Reference

Plugin development checklist Pre-release checklist for IDs, JSON-safe defaults, output shapes, timeline actions, errors and ZIP installation. Complete minimal plugin A complete plugin.json and plugin.py example that registers a working video effect. Skin JSON format Create installable yrendr_skin version 1 themes with the complete editor palette and four extra colors.