Skip to content

Commit 4dbad5b

Browse files
authored
Merge pull request #99 from viruslox/fix-cleanup-and-documentation-13827581527431112193
docs: Cleanup temp files and update architecture/readme documentation
2 parents 7f85667 + a6c5d09 commit 4dbad5b

4 files changed

Lines changed: 6 additions & 105 deletions

File tree

ARCHITECTURE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ An independently spawned Chromium process dynamically rendering up to 7 Z-layers
5050

5151
The FFmpeg Mixer uses advanced `filter_complex` graphs to scale, position, and overlay inputs based on absolute integer-based pixel sizing and X/Y coordinates.
5252

53+
The base canvas size for the filtergraph is defined by `cfg.Input.Resolution` within the `InputSettings`. This establishes the drawing area for all overlays and layers. The final scaled output, which is sent to external destinations, is defined separately by `cfg.Output.Resolution`. Because the input resolution dictates the fundamental structure of the filtergraph and video buffers, any changes to the input resolution require a full FFmpeg restart, whereas changes to individual layer positions or sizes may not.
54+
5355
### VLX Connector (IPC Integration)
5456
To eliminate local SRT network overhead and reduce latency for deployments running alongside `VLX_ChatBridge`, VisionBridge integrates a dedicated IPC connector:
5557
- **Audio Ingress (`ipc_audio`)**: Accepts raw PCM data (`s16le`, 48kHz, 2-channel) directly via a Unix Domain Socket (`/tmp/vlx_audio.sock`), injecting it seamlessly into the FFmpeg audio mixer.

PLAN.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ The service is designed for professional 24/7 broadcasting environments where co
1919
- **Resource Optimization**: Sources marked as "OFF" are completely excluded from the processing pipeline.
2020
- **Multi-Destination**: Single encoding pass with multiple output clones.
2121

22+
## Configuration Concepts
23+
24+
- **Canvas Size vs. Output Size**: The fundamental drawing area for layers and overlays is controlled by `input.resolution` (`InputSettings`). The final resolution of the stream that is encoded and pushed to your destinations is controlled by `output.resolution` (`OutputSettings`).
25+
2226
## Architecture Components
2327

2428
1. **Config Watcher**: Monitors `visionbridge.settings` using `fsnotify`.

plan.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)