Skip to content

Commit 72318d5

Browse files
committed
Update plugin docs for processor examples
Refines `PLUGIN_SYSTEM.md` to reflect the current processor structure: it now points to `examples.py` for sample implementations and keeps `dlc_processor_socket.py` focused on the socket base class. The registration example was also updated to import `register_processor` and `PROCESSOR_REGISTRY` from `dlclivegui.processors` instead of redefining them inline.
1 parent 80907a4 commit 72318d5

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

dlclivegui/processors/PLUGIN_SYSTEM.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Processors are Python classes (typically subclasses of `dlclive.Processor`) that
1616

1717
### Useful files
1818

19-
- `dlclivegui/processors/dlc_processor_socket.py` — Example socket-based processor base class + examples
19+
- `dlclivegui/processors/dlc_processor_socket.py` — Example socket-based processor base class
20+
- `dlclivegui/processors/examples.py` — Example processor implementations (e.g., One-Euro filter)
2021
- `dlclivegui/processors/processor_utils.py` — Scanning + instantiation helpers used by the GUI
2122

2223
---
@@ -204,12 +205,7 @@ The built-in `BaseProcessorSocket` (in `dlc_processor_socket.py`) demonstrates a
204205

205206
```python
206207
from dlclive import Processor
207-
208-
PROCESSOR_REGISTRY = {}
209-
210-
def register_processor(cls):
211-
PROCESSOR_REGISTRY[getattr(cls, "PROCESSOR_ID", cls.__name__)] = cls
212-
return cls
208+
from dlclivegui.processors import register_processor, PROCESSOR_REGISTRY
213209

214210
@register_processor
215211
class MyNewProcessor(Processor):

0 commit comments

Comments
 (0)