| title | Aiko Services PipelineElements documentation | ||
|---|---|---|---|
| description | Index of OKF concept documents for the PipelineElement library in src/aiko_services/elements/ — control, gstreamer, media, observe and utilities packages, with their example PipelineDefinitions | ||
| type | index | ||
| audience |
|
||
| status | draft | ||
| ste | adapted | ||
| version | 0.6 | ||
| last_updated | 2026-08-01 |
This directory documents the PipelineElement library —
src/aiko_services/elements/ — the processing nodes assembled into
Pipelines by PipelineDefinition JSON files.
One OKF concept document per source module, grouped by package,
mirroring the source layout. Each package index also maps the committed
example PipelineDefinitions to the documents covering the elements they
exercise.
These documents build on the Concepts guide,
and in particular on these five documents:
PipelineElement,
Parameters, Stream,
Data Source / Target and
Scheme. They follow the same
audience-first template
(documentation/constitution/t_00_OkfConceptTemplate.md).
| Package | Contents |
|---|---|
| control/ | Control-flow elements — the Loop element repeating a graph section until an S-expression condition becomes false |
| gstreamer/ | RTSP PipelineElements and the rtsp DataScheme (current style), plus the legacy GStreamer video reader/writer wrapper classes |
| media/ | The largest family — text, image, video, webcam and audio elements, the file / tty / zmq DataSchemes, and twenty example PipelineDefinitions |
| observe/ | Observability elements — Inspect (log/file/stdout taps on Frame data) and Metrics (per-element timing and memory) |
| utilities/ | The Expression element and S-expression evaluation helpers for the define, delete and rename commands on Frame data values |
- Building a first Pipeline: media/elements.md (Mock and NoOp) and media/text_io.md, driven by the example PipelineDefinitions in the media index.
- Working with cameras and video: media/webcam_io.md, media/video_io.md, then gstreamer/rtsp_io.md for network cameras.
- Writing a new PipelineElement: read PipelineElement and Data Source / Target first, then copy the closest element here. observe/ and utilities/ show the smallest complete examples.
The element library is under active development (version 0.6), and its maturity is mixed. Some modules are current DataSource / DataTarget style. Others are legacy wrappers or dormant Pipeline_2020-era scripts. Each document states which of these applies. Each document also separates implemented behavior from planned or work-in-progress behavior, based on the source code as of 2026-07-06.
- Concepts guide — the framework concepts these elements are built on
- Examples guide — complete example applications whose Pipelines deploy these elements alongside their own