Skip to content
ZLMediaKitPublic

About

Python实现的ZLMediaKit后台管理网站和系统

Resources

Stars

208 stars

Watchers

0 watching

Forks

Repository files navigation

PyMKUI

PyMKUI 是一个为 ZLMediaKit 设计的现代化 Web 管理界面,基于 Python 插件机制深度集成,提供直观、美观的流媒体服务器管理功能。

⚠️ 项目正处于快速迭代期,数据库结构频繁变动。每次更新代码后请先删除旧数据库:

rm data/pymkui.db

数据库将在下次启动时自动重建。


功能特性

  • 🎬 视频流管理 — 查看、播放、停止流,获取截图;RTMP/TS 流由 h265web.js 播放
  • 🎚️ 播放增强 — SDK 播放弹窗提供稳定音量与实验性 SDR 超分开关,显示实际效果、输出尺寸和当前可用条件
  • 📡 拉流代理 — 多备用地址、按需/立即模式、自动故障切换、持久化恢复、在线编辑
  • 🔄 转协议预设 — 保存多套转协议参数,拉流时一键加载,支持加载服务器默认值
  • 👥 观众列表 — 实时查看每路流的在线观众及连接信息
  • 📊 服务器监控 — CPU、内存、磁盘、网络实时图表
  • ⚙️ 服务配置 — 在线读写 ZLMediaKit 配置项
  • 🌐 在线推流 — 基于 WHIP 协议的浏览器端直播推流
  • 🔗 网络连接 — 查看和管理当前所有 TCP/UDP 会话
  • 📁 录像管理 — 录像文件分流、分日期浏览,支持检索、在线播放与下载,自动按策略清理过期文件
  • 🧩 插件系统 — 内置可扩展 Python 事件钩子,支持用户自定义推流鉴权、录制回调、流上下线通知等业务逻辑,无需修改核心代码
  • 🩺 视频质量探针 — 对推拉流实时采样分析,输出码率、帧率、GOP、音视频交织性等多维度质量指标,以折线图与打点图直观呈现,快速定位卡顿、花屏等异常

快速开始(Docker 一键部署)

已集成到 ZLMediaKit Docker 镜像中,无需手动配置:

docker run -id \
  -p 1935:1935 \
  -p 80:80 \
  -p 443:443 \
  -p 554:554 \
  -p 10000:10000 \
  -p 10000:10000/udp \
  -p 8000:8000/udp \
  -p 9000:9000/udp \
  zlmediakit/zlmediakit:master_py

启动后浏览器访问 http://<服务器IP>/,输入 api.secret 密钥即可登录。

端口说明

端口 协议 用途
80 TCP HTTP(前端 + API)
443 TCP HTTPS / WSS
1935 TCP RTMP
554 TCP RTSP
10000 TCP/UDP RTP
8000 UDP WebRTC
9000 UDP SRT

手动部署(源码方式)

适用于自行编译 ZLMediaKit 并希望使用 PyMKUI 的场景。

项目结构

pymkui/
├─ frontend/          # 静态前端页面
├─ backend/           # Python 插件与 FastAPI 接口
│  ├─ mk_plugin.py    # ZLMediaKit Python 插件入口
│  ├─ py_http_api.py  # FastAPI HTTP API
│  ├─ database.py     # SQLite 数据库
│  ├─ config.py       # 路径配置
│  ├─ mk_logger.py    # 日志封装
│  └─ shared_loop.py  # asyncio 事件循环共享
├─ data/              # 运行时自动生成
│  └─ pymkui.db       # ⚠️ 升级时请删除
└─ README.md

步骤 1:安装 Python 依赖

需要 Python 3.10+

cd pymkui/backend
pip install -r requirements.txt
conda / venv / uv 方式
# conda
conda create -n pymkui python=3.12 && conda activate pymkui
pip install -r requirements.txt

# venv (Linux/Mac)
python -m venv venv && source venv/bin/activate && pip install -r requirements.txt

# venv (Windows)
python -m venv venv && venv\Scripts\activate && pip install -r requirements.txt

# uv
uv sync

步骤 2:编译 ZLMediaKit 时开启 Python 支持

# 安装 Python 相关依赖
apt-get update && apt-get install -y python3 python3-dev python3-pip
# cmake时指定开启python相关特性
cmake .. -DENABLE_PYTHON=ON

步骤 3:修改 config.ini

[python]
plugin=mk_plugin

[http]
rootPath=/path/to/pymkui/frontend

步骤 4:让 ZLMediaKit 找到 backend 模块

# Linux/Mac
export PYTHONPATH=/path/to/pymkui/backend:$PYTHONPATH

# Windows
set PYTHONPATH=C:\pymkui\backend;%PYTHONPATH%

步骤 5:启动并验证

# 启动 ZLMediaKit
./MediaServer

# 验证前端可访问
curl -sv http://localhost:80/login.html
# 应返回 HTTP/1.1 200 OK

h265web.js 播放入口

视频管理页的「播放」按钮对 RTMP 和 TS 流分别使用 ZLM 的 HTTP-FLV、HTTP-TS 地址并交给 h265web.js,按当前流的 vhost 获取 on_play 附加参数,默认静音。播放失败时可在弹窗中重试;重试先释放旧播放器,再重新请求播放授权。Jessibuca 不再由视频管理页加载或创建。H.265 MPEG-TS HLS 行也使用 h265web.js;H.264 HLS 优先保留原生播放,只在原生解码/资源错误(3/4)后重新获取授权并尝试一次 SDK MSE 播放。HTTP-fMP4 和 WHEP 保留原生播放路径。H.265 HLS-fMP4 暂不支持,页面会明确提示。

弹窗默认显示平面视频。确认当前流是 ERP 360 视频时,可点「360°模式」切换为可拖动/触摸旋转、滚轮缩放的透视视角;「重置视角」恢复初始方向,「平面模式」切回原画面。流列表没有可靠的 ERP 标记,因此不会按分辨率自动开启 360°。现有全屏和截图按钮在两种画面模式下共用。录像管理的单文件 MP4/WebM 播放也使用 h265web.js,提供播放、暂停、seek、倍速、全屏、截图和手动 360°模式;ERP 模式下可重置视角。全天跨文件播放保留原有方式。WebM 和原生 HEVC 点播受浏览器解码能力限制。

播放资源位于 frontend/js/lib/h265web/,包括同一次构建的 h265web.js、h265web_wasm.js、h265web_wasm.wasm,共享控件 demo-enhancements.js/.css 以及完整 models/sr/ 模型目录。部署时一起提供这些本地资源,并检查 JS/WASM MIME、媒体 CORS 和 WebAssembly 线程所需的跨源隔离响应头。模型只在超分需要时加载。

稳定音量与 SDR 超分

HTTP-FLV、HTTP-TS、H.265 MPEG-TS HLS、AVC 原生 HLS 的 SDK 回退,以及单文件 MP4/WebM 的 SDK 弹窗使用同一组增强开关,默认均关闭。

  • 稳定音量:播放过程中直接开关,自动减少忽大忽小。状态显示实际启用结果;用户静音和最终音量保持独立。
  • SDR 超分:播放前可预选,播放中也可开启或关闭。首次开启默认选择当前可用的高一档;需要由播放器自行选档时,切回“自动”。输出尺寸和状态表示实际渲染结果。
  • SDR 确认与重建:任意流默认按未知色彩处理。确认片源为 SDR 后选择相应设置;修改色彩声明或当前渲染器需要重建时,点击面板中的应用按钮。直播重新获取播放授权并接入,录像从头重新加载,开关偏好保留。
  • 状态指引:正在等待画面、模型加载、实际增强、保持原画及原因分别显示。ERP 全景、HDR、无需放大的显示尺寸或设备性能条件会显示对应指引。

首次使用可先保持默认播放,再开启稳定音量;确认 SDR 后开启超分,对比关闭时的原画。两项功能均由 SDK 的公开接口处理,弹窗中的播放、暂停、全屏、截图、VR、seek 和倍速沿用同一播放器。

SDK 还提供 接入 skill 和 排障 skill,覆盖原生 JS 与常见前端框架,包含新增音频和超分状态的接入、检查及问题定位说明。


界面展示

登录 服务器状态
流管理 流信息
流播放 观众列表
系统设置 网络连接
在线推流 拉流代理
拉流代理详情 添加拉流代理
录像管理 播放全天录像
插件系统 插件配置
流信息 探针详情

常见问题

问题 解决方法
zlm打印Python调用红色错误日志 同时更新zlm和pymkui至最新版本
/index/pyapi/* 返回未登录 正常现象,API 已通,完成登录即可
配了 rootPath 仍 404 确认路径指向 frontend/ 目录且 login.html 存在
启动报数据库错误 删除 data/pymkui.db 后重启

技术栈

层级 技术
前端 HTML5 + Tailwind CSS + Font Awesome
播放器 h265web.js(HTTP-FLV/HTTP-TS、HLS、单文件 MP4/WebM)、原生 HTTP-fMP4、WHEP (WebRTC)
后端 Python + FastAPI(内嵌于 ZLMediaKit Python 插件)
数据库 SQLite
服务器 ZLMediaKit (C++)

未来规划

  • 🤖 AI 推理集成 — 对接 ONNX / TensorRT / OpenCV DNN,实现实时视频分析(目标检测、人脸识别等)

贡献

欢迎提交 Issue 和 Pull Request。

许可证

MIT License

About

Python实现的ZLMediaKit后台管理网站和系统

Resources

Stars

208 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages