Skip to content

Utility Plugins

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

PluginFeatureHTTP APINotes
LogRotatelogrotateNoLog rotation and retention
DebugdebugBuild-dependentDeveloper diagnostics
SEIseiNoH.264/H.265 SEI injection
CrontabcrontabNo (config-driven)Scheduled tasks
MixmixNo (capability-driven)Multi-stream mixing
CryptocryptoNoMedia encryption capability
ReportreportYesMedia quality metrics reporting
TesttestYesIntegration and stress test APIs
features = ["logrotate"]
logrotate:
path: "./logs"
max_size: 10485760
max_files: 7
level: "info"
features = ["crontab"]
crontab:
jobs:
- name: "daily-record"
cron: "0 8 * * *"
action: "record_start"
stream: "live/camera01"
duration: 3600

Prefix: /report/

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

Core body fields:

FieldTypeRequiredDescription
user_idstringYesUser ID
room_idstringYesRoom ID
sdk_versionstringYesSDK version
report_timeint64YesReport timestamp
metricsarrayYesMetrics entries
GET /report/rooms
GET /report/metrics/{room_id}
GET /report/metrics/{room_id}/{user_id}
GET /report/history/{room_id}

Prefix: /test/. Integration and regression testing; for load testing see stress.

GET /test/
GET /test/integration
GET /test/cases
GET /test/api/cases
GET /test/sse/cases
POST /test/api/cases/execute
POST /test/stop

Execute cases:

{ "names": ["rtmp2rtsp", "rtmp2flv"] }