Aphelion Plugin SDK

Public API for plugins that run inside Aphelion Editor. This package sits beside aphelion-editor, not inside it.

Import aphelion_sdk only. Never import core, effects, render, or ui.

Video effects are available now (VideoEffectPlugin). Audio bases will land under aphelion_sdk.audio later.

Version 0.1.0. Python 3.11+. Distribution name aphelion-sdk.

Install

From the aphelion-engine root, with a venv active:

pip install -e ./aphelion-editor
pip install -e ./aphelion-sdk

Installing the editor already depends on this package (aphelion-sdk @ file:../aphelion-sdk).

aphelion-sdk --version
python -m aphelion_sdk --help

Quick start

import aphelion_sdk


@aphelion_sdk.register_plugin
class GrayscaleEffect(aphelion_sdk.VideoEffectPlugin):
    plugin_name = "Grayscale"
    plugin_category = "Plugins"
    plugin_description = "Blend a frame toward grayscale."
    plugin_color = (140, 140, 140)

    def setup_effect_properties(self) -> None:
        self.set_property(
            "amount",
            aphelion_sdk.slider_property(
                100, 0, 100,
                label="Amount",
                suffix="%",
            ),
        )

    def process_frame(
        self,
        frame: aphelion_sdk.Frame,
        _frame_num: int,
    ) -> aphelion_sdk.Frame:
        amount = self.float_value("amount", 100.0) / 100.0
        luma = (
            frame[..., 0] * 0.2126
            + frame[..., 1] * 0.7152
            + frame[..., 2] * 0.0722
        )
        gray = luma[..., None].repeat(3, axis=2)
        return frame * (1.0 - amount) + gray * amount

Drop the file in the editor's plugins/ or userdata/plugins/, or pack a wheel (below). Time-independent effects should name the unused argument _frame_num.

Examples:

• examples/grayscale_effect.py
• examples/effect_with_widget.py — dialog + panel via widgets = (...)

Documentation

Package a plugin

aphelion-sdk build examples/grayscale_effect.py -o dist
pip install dist/aphelion_plugin_grayscale-*.whl

Entry point group: aphelion.plugins. Widgets are declared on the plugin (widgets = (MyDialog, MyPanel)); they are not registered on their own.

License

Proprietary (LicenseRef-Proprietary in pyproject.toml).