Utility Plugins

This page covers utility plugins that previously had no dedicated pages.

Plugin Matrix

Plugin	Feature	HTTP API	Notes
LogRotate	logrotate	No	Log rotation and retention
Debug	debug	Build-dependent	Developer diagnostics
SEI	sei	No	H.264/H.265 SEI injection
Crontab	crontab	No (config-driven)	Scheduled tasks
Mix	mix	No (capability-driven)	Multi-stream mixing
Crypto	crypto	No	Media encryption capability
Report	report	Yes	Media quality metrics reporting
Test	test	Yes	Integration and stress test APIs

Detailed docs

• Test Plugin
• Report Plugin
• LogRotate Plugin
• Debug Plugin
• SEI Injection Plugin
• Crontab Plugin
• Mix Plugin
• Crypto Plugin

LogRotate

Enable

features = ["logrotate"]

Key config

logrotate:
  path: "./logs"
  max_size: 10485760
  max_files: 7
  level: "info"

Crontab

Enable

features = ["crontab"]

Typical config

crontab:
  jobs:
    - name: "daily-record"
      cron: "0 8 * * *"
      action: "record_start"
      stream: "live/camera01"
      duration: 3600

Report (HTTP API)

Prefix: /report/

Submit metrics

POST /report/metrics
Content-Type: application/json

Core body fields:

Field	Type	Required	Description
user_id	string	Yes	User ID
room_id	string	Yes	Room ID
sdk_version	string	Yes	SDK version
report_time	int64	Yes	Report timestamp
metrics	array	Yes	Metrics entries

List rooms

GET /report/rooms

Room metrics

GET /report/metrics/{room_id}
GET /report/metrics/{room_id}/{user_id}

History

GET /report/history/{room_id}

Test (HTTP API)

Prefix: /test/

Query cases and jobs

GET /test/
GET /test/integration
GET /test/stress
GET /test/cases
GET /test/api/cases
GET /test/api/stress/count

Execute and stress operations

POST /test/api/cases/execute
POST /test/api/stress/push/{protocol}/{count}
POST /test/api/stress/pull/{protocol}/{count}
POST /test/api/stress/stop/push
POST /test/api/stress/stop/pull
POST /test/stop

Key body examples

Execute cases:

{ "names": ["basic_rtmp_to_flv", "webrtc_publish"] }

Stress push:

{
  "remoteURL": "rtmp://localhost/live/stress/%d",
  "streamPath": "live/source"
}

Stress pull:

{
  "remoteURL": "rtmp://localhost/live/source",
  "testMode": 0
}