Plugin Overview

Monibuca V6 adopts a fully plugin-based architecture. All protocol access, utility functions, and device integration are provided as independent plugin crates. The engine core only handles stream management, configuration, and HTTP services, while specific functionality is assembled from plugins as needed.

Plugin List

V6 provides 26 plugins + 1 built-in service (Room), organized into five categories.

Protocol Plugins (8)

Plugin	Feature Flag	Description
RTMP	rtmp	RTMP publish/subscribe, with auth and GOP cache
RTSP	rtsp	RTSP publish/subscribe, TCP/UDP transport
HTTP-FLV	flv	HTTP-FLV streaming, WebSocket-FLV support
HLS	hls	HLS segmentation and playback, LL-HLS support
WebRTC	webrtc	WebRTC publish/subscribe, WHIP/WHEP standard
SRT	srt	SRT protocol, low-latency reliable transport
WebTransport	webtransport	QUIC-based WebTransport protocol support
GB28181	gb28181	GB/T 28181 device access and cascading

Utility Plugins (11)

Plugin	Feature Flag	Description
MP4 Recording	mp4	MP4 recording and VOD playback
Snapshot Service	snap	Video stream snapshots and MJPEG output
Audio Transcoding	ffmpeg_transcode	FFmpeg-based audio/video transcoding
Log Rotation	logrotate	Automatic log file rotation and cleanup
Debug Tools	debug	Development and debugging utilities
SEI Injection	sei	H.264/H.265 SEI data injection
Scheduled Tasks	crontab	Scheduled pull streaming, recording, and other periodic tasks
Stream Mixing	mix	Merge multiple streams into a single output
Encryption	crypto	Media content encryption
Reporting	report	Runtime status and metrics reporting
Testing	test	Automated integration testing plugin

Room Extension Plugins (4)

Plugin	Feature Flag	Description	Documentation
Room Service	room	Room core service (engine built-in), manages room lifecycle, users, WebSocket, callbacks	Details
Live Room	live	Live room management: gift system, co-hosting, PK battles, bot viewers, data persistence	Details
Meeting Room	meeting	Video conferencing: agenda, timer, real-time transcription, AI summary, task extraction	Details
Customer Service	customer-service	1v1 customer service calls: agent management, audio mixing, satisfaction rating	Details

Room Service Specialization

The Room Service is a core built-in component of the engine, not released as an independent plugin. Instead, it is compiled together with the engine via the room feature through conditional compilation. It provides infrastructure and the RoomApi trait interface for all room extension plugins (Live, Meeting, CustomerService).

Device Plugins (3)

Plugin	Feature Flag	Description
ONVIF	onvif	ONVIF protocol device discovery and management
V4L2	v4l2	Linux Video4Linux2 camera capture
ALSA	alsa	Linux ALSA audio capture

Other (1)

Plugin	Feature Flag	Description
HomeKit	homekit	Apple HomeKit camera integration

---

Room System Quick Overview

Monibuca V6’s room system is based on the built-in Room Service and three extension plugins:

┌─────────────────────────────────────────────┐
│         Room Service (Engine Built-in)      │
│  • Room lifecycle management                │
│  • WebSocket connection management          │
│  • User join/leave/heartbeat                │
│  • RoomApi trait and callback system        │
└─────────────────────────────────────────────┘
          ↓ RoomApi trait ↓
┌──────────────────────────────────┬──────────────────────────────────┬──────────────────────────────────┐
│    Live Plugin (Live Room)       │  Meeting Plugin (Meeting Room)   │ CustomerService Plugin           │
│  • Gift system & Combo           │  • Agenda management             │  • 1v1 sessions (max_users: 2)  │
│  • Co-hosting (Link-Mic)         │  • Timer                         │  • Session assignment/transfer   │
│  • PK battles                    │  • Real-time transcription (ASR) │  • Audio mixing                  │
│  • Bot viewers                   │  • AI summary & task extraction  │  • Satisfaction rating           │
│  • Data persistence              │  • Lobby (waiting room)          │  • HTTP API                      │
│  • 100+ viewers                  │  • 50+ participants              │  • 1000+ concurrent sessions    │
└──────────────────────────────────┴──────────────────────────────────┴──────────────────────────────────┘

Scenario Mapping:

• Live streaming scenario → Live plugin + WebRTC publish
• Meeting scenario → Meeting plugin + lobby + recording
• Customer service scenario → CustomerService plugin + HTTP API

See Room System Documentation for details.

---

Enabling Plugins

Monibuca controls plugin compilation and loading through Cargo feature flags. Specify the desired plugins in the [features] section of Cargo.toml:

[dependencies]
monibuca = { version = "6.0", features = ["rtmp", "rtsp", "flv", "hls", "mp4"] }

Common Feature Combinations

# Enable all plugins (default, without rsmpeg)
features = ["all-plugins"]

# Enable all plugins (with rsmpeg FFmpeg library bindings)
features = ["all-plugins-rsmpeg"]

# Minimal protocol set
features = ["rtmp", "flv", "hls"]

# Live streaming scenario (needs Room service)
features = ["rtmp", "flv", "hls", "webrtc", "mp4", "snap", "live", "room"]

# Meeting scenario (needs Room service)
features = ["webrtc", "meeting", "room"]

# Customer service scenario (needs Room service)
features = ["webrtc", "customer-service", "room"]

# Surveillance scenario
features = ["rtsp", "gb28181", "onvif", "mp4", "snap"]

Enabling Individual Plugins

Each plugin corresponds to a feature flag of the same name (except transcoding, which uses ffmpeg_transcode):

features = ["rtmp"]          # Enable RTMP plugin
features = ["snap"]          # Enable snapshot plugin
features = ["ffmpeg_transcode"]  # Enable transcoding plugin
features = ["gb28181"]       # Enable GB28181 plugin

Some plugins have implicit dependencies:

• srt — also pulls in the srt-tokio system dependency
• onvif — automatically enables rtsp
• test — automatically enables rtmp, rtsp, flv, hls, webrtc
• mjpeg — automatically enables snap
• live, meeting, customer-service — automatically enable room

Plugin Loading Modes

Monibuca V6 supports three plugin loading modes:

Static Compilation (Default)

features = ["static-plugins", "rtmp", "flv"]

All enabled plugins are statically linked into the engine binary at compile time. Recommended for production environments, offering the best performance and minimal runtime overhead.

Dynamic Loading

features = ["dynamic-plugins"]

Plugins are compiled as standalone .so / .dylib / .dll dynamic libraries, loaded by the engine at runtime. Suitable for scenarios requiring hot-swappable plugins or on-demand loading.

Dynamic plugins are placed in the directory configured by plugins_dir:

plugins_dir: "./plugins"

WASM Plugins (Experimental)

WASM plugins run in a WebAssembly sandbox, providing better isolation. This mode is still under development.

Plugin Lifecycle

All plugins follow a unified lifecycle management:

Created → Initialized → Running → Stopped
                ↓
             Disabled

1. Created — Plugin instance is created
2. Initialized — init() is called, loading configuration and injecting dependencies
3. Running — start() is called, the plugin begins serving
4. Stopped — stop() is called, graceful shutdown
5. Disabled — enable: false in configuration, startup is skipped

The engine manages the initialization order, dependency injection, and graceful shutdown of all plugins through the PluginManager.