PyMKUI

https://github.com/zlmediakit/pymkui
Admin
PyMKUI is a modern web management interface for ZLMediaKit that provides intuitive stream media...
Tokens:14,653
Snippets:95
Trust Score:8.5
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start ZLMediaKit and Verify

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Start the ZLMediaKit server and verify that the PyMKUI frontend is accessible by making an HTTP request.

```bash
# 启动 ZLMediaKit
./MediaServer

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

--------------------------------

### Install Python Dependencies

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Install the required Python packages for PyMKUI's backend. Ensure you have Python 3.10+ installed.

```bash
cd pymkui/backend
pip install -r requirements.txt
```

--------------------------------

### Custom Plugin Development Example

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Example of a custom plugin inheriting from PluginBase. This plugin demonstrates parameter definition, event handling logic, and returning control to the system.

```python
from py_plugin import PluginBase
import mk_logger

class MyCustomPlugin(PluginBase):
    name = "my_custom_plugin"
    version = "1.0.0"
    description = "自定义插件示例"
    type = "on_play"           # 支持的事件类型
    interruptible = True       # True=拦截型，False=监听型
    multi_binding = False      # 是否允许同一事件多次绑定

    def params(self) -> dict:
        """定义插件可配置参数的 schema"""
        return {
            "whitelist": {
                "type": "str",
                "default": "*",
                "description": "允许播放的流名通配符"
            },
            "log_level": {
                "type": "str",
                "default": "info",
                "description": "日志级别"
            }
        }

    def run(self, **kwargs) -> bool:
        """
        事件处理主逻辑
        返回 True 表示接管事件（仅 interruptible=True 时生效）
        返回 False 表示继续执行后续插件
        """
        args = kwargs.get("args", {})
        invoker = kwargs.get("invoker")
        binding_params = kwargs.get("binding_params", {})

        app = args.get("app", "")
        stream = args.get("stream", "")
        whitelist = binding_params.get("whitelist", "*")

        mk_logger.log_info(f"[my_custom_plugin] 播放请求: {app}/{stream}")

        # 自定义逻辑处理
        import fnmatch
        if fnmatch.fnmatch(stream, whitelist):
            # 允许播放
            import mk_loader
            mk_loader.play_auth_invoker_do(invoker, "")
            return True
        else:
            # 拒绝播放
            mk_loader.play_auth_invoker_do(invoker, "stream not allowed")
            return True

    def get_url_params(self, **kwargs) -> dict:
        """可选：返回需要附加到播放 URL 的查询参数"""
        return {"custom_param": "value"}
```

--------------------------------

### Install Python Dependencies with venv (Windows)

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Install Python dependencies using venv on Windows. Activate the virtual environment before installing.

```bash
python -m venv venv && venv\Scripts\activate && pip install -r requirements.txt
```

--------------------------------

### Get Server Configuration

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Fetches the current server configuration settings.

```javascript
const config = await Api.getServerConfig();
```

--------------------------------

### Install Python Dependencies with venv (Linux/Mac)

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Install Python dependencies using venv on Linux or macOS. Activate the virtual environment before installing.

```bash
python -m venv venv && source venv/bin/activate && pip install -r requirements.txt
```

--------------------------------

### Get All Event Bindings

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves the current configuration for all event bindings, showing which plugins are associated with which events.

```bash
curl -X GET "http://localhost:8080/index/pyapi/plugin/bindings" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Get Supported Event Types

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Fetches a list of all event types that plugins can be registered to handle.

```bash
curl -X GET "http://localhost:8080/index/pyapi/plugin/events" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Install Python Dependencies with Conda

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Install Python dependencies using Conda, creating a dedicated environment for PyMKUI.

```bash
conda create -n pymkui python=3.12 && conda activate pymkui
pip install -r requirements.txt
```

--------------------------------

### Docker Deployment

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Deploy PyMKUI with ZLMediaKit using a single Docker command. Access the interface at http://<server-ip>/ after starting.

```bash
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-pro:feature_all
```

--------------------------------

### Get Loaded Plugin List

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of all currently loaded plugins in the PyMKUI system. The response includes plugin name, version, description, type, and configuration schema.

```bash
curl -X GET "http://localhost:8080/index/pyapi/plugin/list" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Get Host System Stats

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves real-time CPU, memory, disk, and network usage for the host system. Requires authentication via session cookie.

```bash
# 获取主机系统资源使用率
curl -X GET "http://localhost:8080/index/pyapi/host-stats" \
  -H "Cookie: your_session_cookie"
```

```json
# 响应示例
{
    "code": 0,
    "data": {
        "time": "14:30:00",
        "cpu": 12.5,
        "memory": {"used": 2.1, "total": 8.0},
        "disk": {"used": 50.3, "total": 200.0},
        "network": {"sent": 1024.5, "recv": 2048.3, "sent_total": 10240, "recv_total": 20480}
    }
}
```

--------------------------------

### Compile ZLMediaKit with Python Support

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Compile ZLMediaKit with Python support enabled. This requires installing Python development dependencies first.

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

--------------------------------

### Get URL Parameters for Plugins

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves query parameters that plugins will append to playback URLs. Useful for obtaining authentication tokens or other dynamic parameters.

```bash
curl -X GET "http://localhost:8080/index/pyapi/plugin/url_params?event_type=on_play&app=live&stream=test" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Get Media Info

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Fetches detailed information about a specific media stream. Requires stream identification parameters.

```javascript
const mediaInfo = await Api.getMediaInfo('rtsp', '__defaultVhost__', 'live', 'test');
```

--------------------------------

### Get Media List

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of all active media streams on the server. Requires specifying the schema, vhost, app, and stream pattern.

```javascript
const mediaList = await Api.getMediaList('rtsp', '__defaultVhost__', 'live', '');
```

--------------------------------

### Manage Stream Proxies

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Provides API endpoints to get, toggle mode, and delete stream proxy configurations. Requires a session cookie for authentication.

```bash
# 获取拉流代理列表
curl -X GET "http://localhost:8080/index/pyapi/getStreamProxyList" \
  -H "Cookie: your_session_cookie"
```

```bash
# 获取单个拉流代理详情
curl -X GET "http://localhost:8080/index/pyapi/getStreamProxy?id=1" \
  -H "Cookie: your_session_cookie"
```

```bash
# 切换拉流代理模式（按需↔立即）
curl -X POST "http://localhost:8080/index/pyapi/toggleStreamProxyMode" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'
```

```bash
# 删除拉流代理
curl -X POST "http://localhost:8080/index/pyapi/delStreamProxy" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'
```

--------------------------------

### Get Streams with Recordings

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of all streams that have associated MP4 recordings. Requires a session cookie for authentication.

```bash
# 获取所有有录像的流列表
curl -X GET "http://localhost:8080/index/pyapi/recordings/streams" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Get Media Player List

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of all clients currently connected to a specific media stream. Requires stream identification parameters.

```javascript
const players = await Api.getMediaPlayerList('rtsp', '__defaultVhost__', 'live', 'test');
```

--------------------------------

### Get Network Connections

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of all active network connections to the server.

```javascript
const sessions = await Api.getNetworkList();
```

--------------------------------

### Frontend Login Flow

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Example JavaScript function for frontend login using ZLMediaKit's cookie and digest authentication. Requires the secret key and server URL. It first fetches a cookie and then calculates an MD5 digest for authentication.

```javascript
// 前端登录流程示例（api.js）
async function login(secret, serverUrl) {
    // 1. 获取 cookie
    const response1 = await fetch(serverUrl + '/index/api/getApiList', {
        method: 'POST',
        credentials: 'include'
    });
    const data1 = await response1.json();
    const cookie = data1.cookie;  // code=-100 时返回 cookie

    // 2. 计算 digest = MD5("zlmediakit:" + secret + ":" + cookie)
    const digestStr = `zlmediakit:${secret}:${cookie}`;
    const digest = md5(digestStr);

    // 3. 完成登录
    const response2 = await fetch(serverUrl + '/index/api/login', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ digest }),
        credentials: 'include'
    });
    const data2 = await response2.json();
    return data2.code === 0;  // true = 登录成功
}
```

--------------------------------

### Get All Recordings for a Day

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves all MP4 recordings for a specific stream on a given day, ordered chronologically. Useful for sequential playback. Requires a session cookie.

```bash
# 获取指定流某天的全部录像（用于顺序播放）
curl -X GET "http://localhost:8080/index/pyapi/recordings/day?app=live&stream=test&date=2024-03-18" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Get Stream Snapshot

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Captures a snapshot of a media stream. Requires the stream URL, timeout, and width. The result contains a Blob URL for the image.

```javascript
const snapResult = await Api.getSnap('rtsp://127.0.0.1/live/test', 5, 3);
if (snapResult.code === 0) {
    document.getElementById('snapshot').src = snapResult.data;  // Blob URL
}
```

--------------------------------

### Delete Old Database

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

Before updating PyMKUI, remove the old database file to ensure a clean setup. The database will be automatically rebuilt on the next startup.

```bash
rm data/pymkui.db
```

--------------------------------

### Get Recording Dates for Month

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieves a list of dates within a specific month that have MP4 recordings for a given stream. Useful for populating a calendar view. Requires a session cookie.

```bash
# 获取某月有录像的日期列表（日历组件用）
curl -X GET "http://localhost:8080/index/pyapi/recordings/dates?year=2024&month=3&app=live&stream=test" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### ZLMediaKit Stream Management API

Source: https://context7.com/zlmediakit/pymkui/llms.txt

APIs for managing streams within ZLMediaKit, including getting stream lists, closing streams, taking snapshots, and managing recordings and server configurations.

```APIDOC
// Note: These are JavaScript examples using an assumed `api.js` wrapper.

## Get Media List

### Description
Retrieves a list of media streams.

### Method
GET (via `Api.getMediaList`)

### Parameters
- **schema** (string) - e.g., 'rtsp'
- **vhost** (string) - Virtual host name.
- **app** (string) - Application name.
- **stream** (string) - Stream name (can be empty).

### Example Usage
```javascript
const mediaList = await Api.getMediaList('rtsp', '__defaultVhost__', 'live', '');
// mediaList.data = [{schema, vhost, app, stream, tracks, originType, ...}, ...]
```
```

```APIDOC
## Get Media Info

### Description
Retrieves detailed information about a specific media stream.

### Method
GET (via `Api.getMediaInfo`)

### Parameters
- **schema** (string) - e.g., 'rtsp'
- **vhost** (string) - Virtual host name.
- **app** (string) - Application name.
- **stream** (string) - Stream name.

### Example Usage
```javascript
const mediaInfo = await Api.getMediaInfo('rtsp', '__defaultVhost__', 'live', 'test');
```
```

```APIDOC
## Close Stream

### Description
Closes a specific media stream.

### Method
DELETE (via `Api.closeStream`)

### Parameters
- **schema** (string) - e.g., 'rtsp'
- **vhost** (string) - Virtual host name.
- **app** (string) - Application name.
- **stream** (string) - Stream name.

### Example Usage
```javascript
await Api.closeStream('rtsp', '__defaultVhost__', 'live', 'test');
```
```

```APIDOC
## Get Snap

### Description
Captures a snapshot of a media stream.

### Method
GET (via `Api.getSnap`)

### Parameters
- **url** (string) - The stream URL (e.g., 'rtsp://127.0.0.1/live/test').
- **width** (integer) - Desired snapshot width.
- **height** (integer) - Desired snapshot height.

### Example Usage
```javascript
const snapResult = await Api.getSnap('rtsp://127.0.0.1/live/test', 5, 3);
if (snapResult.code === 0) {
    document.getElementById('snapshot').src = snapResult.data;  // Blob URL
}
```
```

```APIDOC
## Get Media Player List

### Description
Retrieves a list of players connected to a specific stream.

### Method
GET (via `Api.getMediaPlayerList`)

### Parameters
- **schema** (string) - e.g., 'rtsp'
- **vhost** (string) - Virtual host name.
- **app** (string) - Application name.
- **stream** (string) - Stream name.

### Example Usage
```javascript
const players = await Api.getMediaPlayerList('rtsp', '__defaultVhost__', 'live', 'test');
```
```

```APIDOC
## Record Stream (Start/Stop)

### Description
Starts or stops recording a media stream. Supports HLS (type 0) and MP4 (type 1).

### Method
POST (via `Api.startRecord`, `Api.stopRecord`)

### Parameters
- **type** (integer) - Recording type: 0 for HLS, 1 for MP4.
- **vhost** (string) - Virtual host name.
- **app** (string) - Application name.
- **stream** (string) - Stream name.

### Example Usage
```javascript
// Start HLS recording
await Api.startRecord(0, '__defaultVhost__', 'live', 'test');
// Stop MP4 recording
await Api.stopRecord(1, '__defaultVhost__', 'live', 'test');
```
```

```APIDOC
## Get Server Config

### Description
Retrieves the current ZLMediaKit server configuration.

### Method
GET (via `Api.getServerConfig`)

### Example Usage
```javascript
const config = await Api.getServerConfig();
```
```

```APIDOC
## Set Server Config

### Description
Modifies ZLMediaKit server configuration parameters.

### Method
PUT (via `Api.setServerConfig`)

### Parameters
- **config** (object) - An object containing key-value pairs of configuration parameters to update.

### Example Usage
```javascript
await Api.setServerConfig({
    'protocol.enable_hls': '1',
    'protocol.enable_mp4': '0'
});
```
```

```APIDOC
## Get Network List

### Description
Retrieves a list of all active network connections on the server.

### Method
GET (via `Api.getNetworkList`)

### Example Usage
```javascript
const sessions = await Api.getNetworkList();
```
```

--------------------------------

### Troubleshoot Database Errors

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

If startup fails with database errors, delete the `data/pymkui.db` file and restart the server.

```text
启动报数据库错误
删除 `data/pymkui.db` 后重启
```

--------------------------------

### One-Click Docker Deployment

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Deploys a complete ZLMediaKit + PyMKUI environment using the official Docker image. Exposes various ports for streaming protocols and web access. Access the web interface via HTTP and use the secret from config.ini for login.

```bash
# 一键部署（已集成 PyMKUI）
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-pro:feature_all

# 访问 Web 界面
# 浏览器打开 http://<服务器IP>/
# 使用 config.ini 中的 api.secret 作为密钥登录

# 端口说明：
# 80    - HTTP（前端 + API）
# 443   - HTTPS / WSS
# 1935  - RTMP
# 554   - RTSP
# 10000 - RTP (TCP/UDP)
# 8000  - WebRTC
# 9000  - SRT

```

--------------------------------

### Troubleshoot 404 Errors for rootPath

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

If you encounter 404 errors after configuring `rootPath`, ensure the path correctly points to the `frontend/` directory and that `login.html` exists within it.

```text
配了 rootPath 仍 404
确认路径指向 `frontend/` 目录且 `login.html` 存在
```

--------------------------------

### Database Operations with SQLite

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Demonstrates using the Database class for SQLite operations, including adding pull proxies, setting multi-urls for failover, retrieving proxy details, adding recording entries, querying recordings, and managing plugin bindings for events like 'on_play'.

```python
# backend/database.py 使用示例
from database import Database

db = Database()

# 添加拉流代理
proxy_id = db.add_pull_proxy({
    "vhost": "__defaultVhost__",
    "app": "live",
    "stream": "camera1",
    "remark": "前门摄像头",
    "custom_params": '{"retry_count": 3, "timeout_sec": 10}',
    "protocol_params": '{"enable_hls": "1"}',
    "on_demand": 0
})

# 设置多地址（故障转移）
db.set_proxy_urls(proxy_id, [
    {"url": "rtsp://192.168.1.100/stream", "params": {"rtp_type": "0"}},
    {"url": "rtsp://192.168.1.101/stream", "params": {"rtp_type": "0"}}
])

# 获取代理详情（含多地址）
proxy = db.get_pull_proxy_with_urls(proxy_id)
print(proxy)  # {"id": 1, "app": "live", ..., "urls": [...]} 

# 添加录像记录
db.add_recording({
    "vhost": "__defaultVhost__",
    "app": "live",
    "stream": "camera1",
    "file_name": "2024-03-18_14-30-00.mp4",
    "file_path": "/data/records/live/camera1/2024-03-18_14-30-00.mp4",
    "file_size": 1024000,
    "url": "rtsp://192.168.1.100/stream",
    "start_time": 1710751800,
    "time_len": 3600.5
})

# 查询录像
recordings = db.get_recordings(app="live", stream="camera1", date="2024-03-18", limit=100)

# 插件绑定管理
db.save_plugin_bindings_for_event("on_play", [
    {"plugin_name": "play_token_auth", "params": {"expire_seconds": 300}}
], enabled=1)

bindings = db.get_plugin_bindings_for_event("on_play")

```

--------------------------------

### Build Play URLs for Various Protocols

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Constructs playback URLs for different streaming protocols (RTMP, HTTP-FLV, WebSocket-FLV, HLS, HTTP-FMP4, WebSocket-FMP4, RTSP, WebRTC) based on host, port, app, and stream. Optionally includes token for authentication.

```javascript
function buildPlayUrls(host, port, app, stream, vhost = '__defaultVhost__') {
    const baseHttp = `http://${host}:${port}`;
    const baseWs = `ws://${host}:${port}`;

    return {
        // RTMP 播放
        rtmp: `rtmp://${host}:1935/${app}/${stream}`,

        // HTTP-FLV 播放
        httpFlv: `${baseHttp}/${app}/${stream}.live.flv`,

        // WebSocket-FLV 播放
        wsFlv: `${baseWs}/${app}/${stream}.live.flv`,

        // HLS 播放
        hls: `${baseHttp}/${app}/${stream}/hls.m3u8`,

        // HTTP-FMP4 播放
        httpFmp4: `${baseHttp}/${app}/${stream}.live.mp4`,

        // WebSocket-FMP4 播放
        wsFmp4: `${baseWs}/${app}/${stream}.live.mp4`,

        // RTSP 播放
        rtsp: `rtsp://${host}:8554/${app}/${stream}`,

        // WebRTC 播放 (WHEP)
        webrtc: `${baseHttp}/index/api/whep?app=${app}&stream=${stream}`,

        // 如果有鉴权 token，追加到 URL
        // httpFlvWithToken: `${baseHttp}/${app}/${stream}.live.flv?token=xxx`
    };
}
```

```javascript
async function getPlayUrlWithAuth(app, stream) {
    const params = await Api.getPluginUrlParams('on_play', app, stream);
    const tokenParam = params.data?.token ? `?token=${params.data.token}` : '';
    return `http://localhost:8080/${app}/${stream}.live.flv${tokenParam}`;
}
```

--------------------------------

### Add Protocol Options Preset

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Adds a new preset for protocol conversion options. This allows saving and reusing configurations for HLS, MP4, RTSP, and RTMP. Requires a session cookie.

```bash
# 添加转协议预设
curl -X POST "http://localhost:8080/index/pyapi/add_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{
    "name": "高清录像配置",
    "enable_hls": "1",
    "enable_mp4": "1",
    "enable_rtsp": "1",
    "enable_rtmp": "1",
    "enable_audio": "1",
    "mp4_max_second": "3600",
    "mp4_save_path": "/data/records",
    "auto_close": "0"
}'
```

--------------------------------

### Manage Protocol Options Presets

Source: https://context7.com/zlmediakit/pymkui/llms.txt

API endpoints for managing protocol conversion presets, including listing, retrieving details, updating, and deleting presets. Requires a session cookie.

```bash
# 获取所有预设列表
curl -X GET "http://localhost:8080/index/pyapi/get_protocol_options_list" \
  -H "Cookie: your_session_cookie"
```

```bash
# 获取预设详情
curl -X GET "http://localhost:8080/index/pyapi/get_protocol_options?id=1" \
  -H "Cookie: your_session_cookie"
```

```bash
# 更新预设
curl -X POST "http://localhost:8080/index/pyapi/update_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1, "name": "更新后的配置名", "enable_mp4": "0"}'
```

```bash
# 删除预设
curl -X POST "http://localhost:8080/index/pyapi/delete_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'
```

--------------------------------

### Protocol Preset Management API

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Manage preset configurations for protocol conversion, allowing users to save and apply different settings for stream conversion.

```APIDOC
## Protocol Preset Management API

### Description
Manage preset configurations for protocol conversion. These presets can define various settings like HLS, MP4 recording, audio inclusion, and save paths, which can then be applied to streams.

### Method
POST, GET

### Endpoint
- `POST /index/pyapi/add_protocol_options`
- `GET /index/pyapi/get_protocol_options_list`
- `GET /index/pyapi/get_protocol_options?id={preset_id}`
- `POST /index/pyapi/update_protocol_options`
- `POST /index/pyapi/delete_protocol_options`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **id** (integer) - Required for `get_protocol_options`, `update_protocol_options`, and `delete_protocol_options`. The unique identifier of the protocol preset.

#### Request Body
##### `add_protocol_options` / `update_protocol_options`
- **id** (integer) - Required for `update_protocol_options`. The ID of the preset to update.
- **name** (string) - The name of the preset.
- **enable_hls** (string) - "1" to enable HLS, "0" to disable.
- **enable_mp4** (string) - "1" to enable MP4 recording, "0" to disable.
- **enable_rtsp** (string) - "1" to enable RTSP, "0" to disable.
- **enable_rtmp** (string) - "1" to enable RTMP, "0" to disable.
- **enable_audio** (string) - "1" to enable audio, "0" to disable.
- **mp4_max_second** (string) - Maximum duration in seconds for MP4 recording segments.
- **mp4_save_path** (string) - Directory path for saving MP4 recordings.
- **auto_close** (string) - "0" to keep stream open, "1" to auto-close after inactivity (behavior may vary).

##### `delete_protocol_options`
- **id** (integer) - Required. The ID of the preset to delete.

### Request Example
```bash
# Add a protocol preset
curl -X POST "http://localhost:8080/index/pyapi/add_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d 
'{ 
    "name": "HD Recording Config",
    "enable_hls": "1",
    "enable_mp4": "1",
    "enable_rtsp": "1",
    "enable_rtmp": "1",
    "enable_audio": "1",
    "mp4_max_second": "3600",
    "mp4_save_path": "/data/records",
    "auto_close": "0"
}'

# Get all presets list
curl -X GET "http://localhost:8080/index/pyapi/get_protocol_options_list" \
  -H "Cookie: your_session_cookie"

# Update a preset
curl -X POST "http://localhost:8080/index/pyapi/update_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1, "name": "Updated Config Name", "enable_mp4": "0"}'

# Delete a preset
curl -X POST "http://localhost:8080/index/pyapi/delete_protocol_options" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'
```

### Response
#### Success Response (200)
- **code** (integer) - 0 for success.
- **msg** (string) - Success message.
- **data** (object or array) - Response data. For list requests, it's an array of preset objects. For single preset requests, it's the preset object. For add/update/delete, it might be empty or contain confirmation details.

#### Response Example
```json
{
    "code": 0,
    "msg": "Add successful",
    "data": {"id": 1}
}
```
```

--------------------------------

### Plugin Management API

Source: https://context7.com/zlmediakit/pymkui/llms.txt

APIs for managing PyMKUI plugins, including listing, reloading, event binding, and URL parameter generation.

```APIDOC
## GET /index/pyapi/plugin/list

### Description
Retrieves a list of all loaded plugins.

### Method
GET

### Endpoint
/index/pyapi/plugin/list

### Response
#### Success Response (200)
- **code** (integer) - Response code, 0 for success.
- **data** (array) - An array of plugin objects, each containing:
  - **name** (string) - The name of the plugin.
  - **version** (string) - The version of the plugin.
  - **description** (string) - A description of the plugin.
  - **type** (string) - The event type the plugin handles.
  - **interruptible** (boolean) - Whether the plugin can interrupt the event flow.
  - **multi_binding** (boolean) - Whether the plugin can be bound multiple times to the same event.
  - **params_schema** (object) - The schema for the plugin's parameters.

### Response Example
```json
{
    "code": 0,
    "data": [
        {
            "name": "play_token_auth",
            "version": "1.0.0",
            "description": "播放鉴权插件",
            "type": "on_play",
            "interruptible": true,
            "multi_binding": true,
            "params_schema": {
                "vhost_filter": {"type": "str", "default": "*"},
                "expire_seconds": {"type": "int", "default": 300}
            }
        }
    ]
}
```
```

```APIDOC
## POST /index/pyapi/plugin/reload

### Description
Reloads all plugins by rescanning the plugins directory.

### Method
POST

### Endpoint
/index/pyapi/plugin/reload

### Response
(No specific success response details provided in the source text.)
```

```APIDOC
## GET /index/pyapi/plugin/events

### Description
Retrieves a list of all supported event types for plugins.

### Method
GET

### Endpoint
/index/pyapi/plugin/events

### Response
(No specific success response details provided in the source text.)
```

```APIDOC
## GET /index/pyapi/plugin/bindings

### Description
Retrieves all current event binding configurations for plugins.

### Method
GET

### Endpoint
/index/pyapi/plugin/bindings

### Response
(No specific success response details provided in the source text.)
```

```APIDOC
## POST /index/pyapi/plugin/bindings/save

### Description
Saves event binding configurations, replacing the existing ones entirely.

### Method
POST

### Endpoint
/index/pyapi/plugin/bindings/save

### Request Body
- **event_type** (string) - Required - The type of event to bind.
- **bindings** (array) - Required - An array of binding objects, each containing:
  - **plugin_name** (string) - The name of the plugin to bind.
  - **params** (object) - Parameters for the plugin binding.
- **enabled** (integer) - Required - Whether the binding is enabled (1 for enabled, 0 for disabled).

### Request Example
```json
{
    "event_type": "on_play",
    "bindings": [
        {"plugin_name": "play_token_auth", "params": {"expire_seconds": 600, "app_filter": "live"}}
    ],
    "enabled": 1
}
```

### Response
(No specific success response details provided in the source text.)
```

```APIDOC
## GET /index/pyapi/plugin/url_params

### Description
Gets URL parameters generated by plugins for a specific stream event.

### Method
GET

### Endpoint
/index/pyapi/plugin/url_params

### Query Parameters
- **event_type** (string) - Required - The type of event (e.g., 'on_play').
- **app** (string) - Required - The application name.
- **stream** (string) - Required - The stream name.

### Response
#### Success Response (200)
- **code** (integer) - Response code, 0 for success.
- **data** (object) - An object containing URL parameters, e.g., `{"token": "abc123xyz"}`.

### Response Example
```json
{"code": 0, "data": {"token": "abc123xyz"}}
```
```

--------------------------------

### Set Server Configuration

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Modifies server configuration settings. Provide an object with the configuration keys and their new values. Note that this is a partial update.

```javascript
await Api.setServerConfig({
    'protocol.enable_hls': '1',
    'protocol.enable_mp4': '0'
});
```

--------------------------------

### Query Recordings with Filters

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Queries for MP4 recordings with various filtering options, including application, stream name, date, and limit. Requires a session cookie.

```bash
# 查询录像列表（支持多种过滤条件）
curl -X GET "http://localhost:8080/index/pyapi/recordings?app=live&stream=test&date=2024-03-18&limit=100" \
  -H "Cookie: your_session_cookie"
```

--------------------------------

### Play or Download Recording File

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Initiates playback (disposition=inline) or download (disposition=attachment) of a specific MP4 recording file. This endpoint redirects to ZLMediaKit's file download interface.

```bash
# 播放/下载录像文件（重定向到 ZLM downloadFile 接口）
# disposition=inline 为播放，disposition=attachment 为下载
curl -L "http://localhost:8080/index/pyapi/recordings/file?id=123&disposition=inline"
```

--------------------------------

### System Performance Monitoring API

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Retrieve real-time system resource usage (CPU, memory, disk, network) for dashboard display.

```APIDOC
## GET /index/pyapi/host-stats

### Description
Retrieves the real-time usage statistics for the host system's CPU, memory, disk, and network.

### Method
GET

### Endpoint
/index/pyapi/host-stats

### Parameters
None

### Request Example
```bash
curl -X GET "http://localhost:8080/index/pyapi/host-stats" \
  -H "Cookie: your_session_cookie"
```

### Response
#### Success Response (200)
- **code** (integer) - Response code, 0 for success.
- **data** (object) - Contains system statistics.
  - **time** (string) - Current time in HH:MM:SS format.
  - **cpu** (number) - CPU usage percentage.
  - **memory** (object) - Memory usage details.
    - **used** (number) - Used memory in GB.
    - **total** (number) - Total memory in GB.
  - **disk** (object) - Disk usage details.
    - **used** (number) - Used disk space in GB.
    - **total** (number) - Total disk space in GB.
  - **network** (object) - Network traffic details.
    - **sent** (number) - Sent data in KB/s.
    - **recv** (number) - Received data in KB/s.
    - **sent_total** (number) - Total sent data in KB.
    - **recv_total** (number) - Total received data in KB.

#### Response Example
```json
{
    "code": 0,
    "data": {
        "time": "14:30:00",
        "cpu": 12.5,
        "memory": {"used": 2.1, "total": 8.0},
        "disk": {"used": 50.3, "total": 200.0},
        "network": {"sent": 1024.5, "recv": 2048.3, "sent_total": 10240, "recv_total": 20480}
    }
}
```
```

--------------------------------

### Start/Stop Recording

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Controls the recording of a media stream. Specify the recording type (HLS or MP4) and stream identification parameters. Use startRecord to begin and stopRecord to end.

```javascript
await Api.startRecord(1, '__defaultVhost__', 'live', 'test');
await Api.stopRecord(1, '__defaultVhost__', 'live', 'test');
```

--------------------------------

### Configure Tailwind CSS Theme and Utilities

Source: https://github.com/zlmediakit/pymkui/blob/main/frontend/login.html

Defines custom colors, fonts, box shadows, and utility classes for the Tailwind CSS framework. Includes gradient backgrounds, text gradients, and custom animations.

```javascript
tailwind.config = {
  theme: {
    extend: {
      colors: {
        primary: '#6366f1',
        secondary: '#8b5cf6',
        accent: '#ec4899',
        dark: '#1e293b',
        light: '#f8fafc',
      },
      fontFamily: {
        inter: ['Inter', 'system-ui', 'sans-serif'],
      },
      boxShadow: {
        'neon': '0 0 15px rgba(99, 102, 241, 0.5)',
        'neon-lg': '0 0 25px rgba(99, 102, 241, 0.6)',
      }
    }
  }
}

@layer utilities {
  .content-auto {
    content-visibility: auto;
  }
  .bg-gradient-primary {
    background: linear-gradient(135deg, #6366f1 0%, #8b5cf6 100%);
  }
  .bg-gradient-secondary {
    background: linear-gradient(135deg, #1e293b 0%, #334155 100%);
  }
  .bg-gradient-accent {
    background: linear-gradient(135deg, #ec4899 0%, #f43f5e 100%);
  }
  .text-gradient {
    background-clip: text;
    -webkit-background-clip: text;
    color: transparent;
    background-image: linear-gradient(135deg, #6366f1 0%, #8b5cf6 100%);
  }
  .animate-float {
    animation: float 6s ease-in-out infinite;
  }
  .animate-pulse-slow {
    animation: pulse 4s cubic-bezier(0.4, 0, 0.6, 1) infinite;
  }
  .animate-glow {
    animation: glow 2s ease-in-out infinite alternate;
  }
  @keyframes float {
    0%, 100% {
      transform: translateY(0px);
    }
    50% {
      transform: translateY(-10px);
    }
  }
  @keyframes glow {
    from {
      box-shadow: 0 0 10px rgba(99, 102, 241, 0.5);
    }
    to {
      box-shadow: 0 0 20px rgba(99, 102, 241, 0.8);
    }
  }
}
```

--------------------------------

### Stream Proxy Management API

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Manage stream proxy configurations, including adding, deleting, and querying proxies with support for multi-address failover and on-demand streaming.

```APIDOC
## Stream Proxy Management API

### Description
APIs for managing stream proxy settings. This includes adding new proxies, retrieving lists or details of existing proxies, toggling their mode (on-demand vs. immediate), and deleting them. Supports multi-backup addresses, on-demand streaming, automatic failover, and persistent configuration.

### Method
POST, GET

### Endpoint
- `POST /index/pyapi/addStreamProxy`
- `GET /index/pyapi/getStreamProxyList`
- `GET /index/pyapi/getStreamProxy?id={proxy_id}`
- `POST /index/pyapi/toggleStreamProxyMode`
- `POST /index/pyapi/delStreamProxy`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **id** (integer) - Required for `getStreamProxy` and modification/deletion endpoints. The unique identifier of the stream proxy.

#### Request Body
##### `addStreamProxy`
- **vhost** (string) - Virtual host name. Defaults to `__defaultVhost__`.
- **app** (string) - Application name.
- **stream** (string) - Stream name.
- **urls** (array of objects) - List of stream source URLs and their parameters.
  - **url** (string) - The URL of the stream source.
  - **params** (object) - Optional parameters for the stream URL.
- **on_demand** (integer) - 0 for immediate, 1 for on-demand streaming.
- **remark** (string) - A descriptive remark for the proxy.
- **protocol_params** (string) - JSON string of protocol-specific parameters (e.g., `{"enable_hls": "1", "enable_mp4": "0"}`).
- **force** (integer) - 1 to force overwrite if a proxy with the same app/stream exists.

##### `toggleStreamProxyMode`
- **id** (integer) - Required. The ID of the stream proxy to toggle.

##### `delStreamProxy`
- **id** (integer) - Required. The ID of the stream proxy to delete.

### Request Example
```bash
# Add a stream proxy
curl -X POST "http://localhost:8080/index/pyapi/addStreamProxy" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d 
'{ 
    "vhost": "__defaultVhost__",
    "app": "live",
    "stream": "test",
    "urls": [
        {"url": "rtsp://192.168.1.100/stream1", "params": {"schema": "rtsp", "rtp_type": "0"}},
        {"url": "rtsp://192.168.1.101/stream1", "params": {"schema": "rtsp"}}
    ],
    "on_demand": 0,
    "remark": "Test camera",
    "protocol_params": "{\"enable_hls\": \"1\", \"enable_mp4\": \"0\"}",
    "force": 1
}'

# Get stream proxy list
curl -X GET "http://localhost:8080/index/pyapi/getStreamProxyList" \
  -H "Cookie: your_session_cookie"

# Toggle mode
curl -X POST "http://localhost:8080/index/pyapi/toggleStreamProxyMode" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'

# Delete stream proxy
curl -X POST "http://localhost:8080/index/pyapi/delStreamProxy" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{"id": 1}'
```

### Response
#### Success Response (200)
- **code** (integer) - 0 for success.
- **msg** (string) - Success message.
- **data** (object) - Response data, may contain:
  - **id** (integer) - The ID of the newly added stream proxy.
  - (Array of objects) - When requesting the list, returns an array of stream proxy objects.

#### Response Example
```json
{
    "code": 0,
    "msg": "Add successful",
    "data": {"id": 1}
}
```
```

--------------------------------

### Save Event Bindings

Source: https://context7.com/zlmediakit/pymkui/llms.txt

Saves event binding configurations. This performs a full replacement of existing bindings with the provided configuration. Ensure all desired bindings are included in the payload.

```bash
curl -X POST "http://localhost:8080/index/pyapi/plugin/bindings/save" \
  -H "Content-Type: application/json" \
  -H "Cookie: your_session_cookie" \
  -d '{
    "event_type": "on_play",
    "bindings": [
        {"plugin_name": "play_token_auth", "params": {"expire_seconds": 600, "app_filter": "live"}}
    ],
    "enabled": 1
}'
```

--------------------------------

### Check Login Status

Source: https://github.com/zlmediakit/pymkui/blob/main/README.md

If `/index/pyapi/*` returns 'not logged in', this is expected behavior. The API is functional; proceed with login.

```text
/index/pyapi/* 返回未登录
```
Tokens:
Raw