查看: 9|回复: 0

迟述智控客户端V1.0

[复制链接]

5

主题

0

回帖

24

积分

管理员

积分
24
发表于 4 小时前 | 显示全部楼层 |阅读模式

# 客户端说明(迟述智控客户端)

> 定位:装在大屏后面的播放主机上,真正解码播放视频/图片。由「播放器 + agent 守护」双进程组成,拷贝即用、开机自启、断网续播。

---

## 一、组成

| 组成 | 文件 | 作用 |
|---|---|---|
| 播放器 | `迟述智控客户端.exe` + `_Data\` | Unity 播放视频/图片/屏保,接收 8888 / 19730 指令 |
| agent | `agent\agent.exe`(Node 打包) | 注册、心跳、素材下载/删除、进程自愈、对外 HTTP 接口 |
| 进程守护(可选) | `watchdog.exe` + `watchdog.ini` | 播放器异常退出后自动拉起 |
| 媒体工具 | `_Data\StreamingAssets\Tools\ffmpeg.exe` | 视频处理辅助 |

---

## 二、端口表

| 端口 | 协议 | 方向 | 用途 | 来源 |
|---|---|---|---|---|
| 8888 | UDP | 入站 | 接收播控台/服务端指令(换行分隔) | `MediaController.udpPort` |
| 19730 | TCP | 入站 | 接收指令,与 UDP 指令格式一致 | `MediaController.tcpPort` |
| 9100 | TCP | 入站 | agent HTTP 接口(服务端调用) | agent `config.json` → `listen_port` |
| 8080 | TCP | 出站 | 访问服务端 API(注册、心跳、下载素材) | agent `config.json` → `server` |

说明:

- 8888(UDP)与 19730(TCP)有**单实例保护**:检测到已有播放器实例占用时,新实例会直接退出,避免指令被旧实例吃掉、表现为「点了没反应」。
- 播放器启动时会清理子进程句柄继承,防止 8888/19730 被 agent 等子进程长期占用。

---

## 三、agent 配置 `config.json`

文件位置:与 `agent.exe` 同目录(播放器托盘菜单「服务端地址」会自动改写其中的 `server`)。

| 参数 | 默认值 | 说明 |
|---|---|---|
| `server` | `http://192.168.1.100:8080` | 服务端地址(含端口) |
| `machine_id` | `auto` | 机器唯一标识,`auto` = 自动生成并持久化 |
| `listen_port` | `9100` | agent HTTP 监听端口 |
| `unity_udp_ip` | `127.0.0.1` | 播放器 UDP 指令地址 |
| `unity_udp_port` | `8888` | 播放器 UDP 指令端口 |
| `unity_tcp_port` | `19730` | 播放器 TCP 指令端口 |
| `unity_process` | `迟述智控客户端` | 播放器进程名(不含 .exe),用于自愈与重启 |
| `media_dir` | `auto` | 媒体落地目录,`auto` = 按 exe 位置自动识别 |
| `screensaver_dir` | `auto` | 屏保落地目录,`auto` = `<播放器根>\screensaver` |
| `heartbeat_interval_ms` | `10000` | 心跳间隔(毫秒) |

> 修改 `config.json` 后需重启 agent 生效;服务端地址也可在播放器托盘菜单里直接修改。

---

## 四、agent 对外接口(9100)

服务端通过这些接口下发指令、读写文件、查询进度:

| 方法 / 路径 | 说明 |
|---|---|
| `GET /health` | 健康检查 |
| `GET /progress` | 当前播放/执行进度 |
| `GET /files?dir=` | 读取本地媒体目录文件列表 |
| `POST /files/upload` | 上传文件到客户机 |
| `POST /files/delete` / `files/rename` | 删除 / 重命名本地文件 |
| `POST /sync` | 触发素材下载同步 |
| `POST /remove` | 删除已下发素材 |
| `POST /unity/restart` | 重启播放器 |
| `POST /cmd` | 转发播控指令给播放器 |
| `POST /screensaver` | 下发屏保配置 |
| `POST /config` | 下发配置(如屏保目录) |
| `POST /playlist` | 下发播放列表 |

agent 主动调用的服务端接口:

| 接口 | 频率 / 时机 |
|---|---|
| `POST /api/clients/register` | 启动时注册(失败随心跳重试) |
| `POST /api/clients/heartbeat` | 每 10 秒,同时取回待下载/待删除/节目单任务 |
| `GET /api/media/:id/file` | 下载素材 |
| `POST /api/sync/:id/progress` | 下载进度回报 |
| `POST /api/sync/:id/report` | 下载结果(done / failed / removed) |

---

## 五、本地文件与目录

| 路径 | 内容 | 说明 |
|---|---|---|
| `_Data\StreamingAssets\video\` | 视频素材 | 服务端下发落地 |
| `_Data\StreamingAssets\img\` | 图片素材 | 服务端下发落地 |
| `_Data\StreamingAssets\screensaver\` | 屏保素材 | 目录可通过服务端改 |
| `_Data\StreamingAssets\Tools\ffmpeg.exe` | 视频工具 | 随包提供 |
| `_Data\StreamingAssets\activation_config.json` | 激活配置 | `targetSceneName`、`rememberActivation`、`secretKey` |
| `agent\config.json` | agent 配置 | 见上表 |
| `agent\agent.log` | agent 日志 | 单文件超 5 MB 直接覆盖,便于回传排查 |

`activation_config.json` 参数:

| 参数 | 示例 | 说明 |
|---|---|---|
| `targetSceneName` | `SampleScene` | 激活后进入的场景 |
| `rememberActivation` | `true` | 是否记住激活状态 |
| `secretKey` | `LOCAL-ACT-...` | 本地激活校验密钥 |

---

## 六、指令

指令经 UDP 8888 / TCP 19730 送达播放器,**一行一条**,常用指令码:

| 指令 | 作用 |
|---|---|
| `play` / `pause` | 播放 / 暂停 |
| `replay` | 重播当前 |
| `prev` / `next` | 上一条 / 下一条 |
| `switch video` / `switch image` | 切换视频 / 图片通道 |
| `qh` | 切换(轮换) |
| `volup` / `voldown` | 音量加 / 减 |
| `seek` | 跳转进度 |
| `saver` | 进入屏保 |
| `rescan` | 重新扫描媒体目录 |
| `abort` | 中止当前任务 |
| `restart` | 重启播放器 |
| `shutdown` | 关机 |

---

## 七、部署与运维

| 操作 | 方法 |
|---|---|
| 安装 | 整个客户端目录拷贝到目标机器,双击 `迟述智控客户端.exe` |
| 多机部署 | 直接复制目录即可,`machine_id` 自动生成、不会串号 |
| 设置服务端 | 托盘菜单 → 服务端地址,或直接改 `agent\config.json` 的 `server` |
| 开机自启 | 程序自动写入注册表 `Run` 项(值名 `迟述智控客户端`) |
| 远程重启播放器 | 服务端「客户机管理 → 重启播控」,或 `POST /unity/restart` |
| 排障 | 查看 `agent\agent.log` 与播放器日志 |

---

## 八、系统要求

| 项目 | 要求 |
|---|---|
| 操作系统 | Windows 7 SP1 / 8 / 8.1 / 10 / 11(64 位为主,32 位系统需对应 32 位包) |
| 显卡 | 支持硬件解码更佳(H.264/H.265) |
| 网络 | 与部署机同一局域网,能访问服务端 8080 |
| 权限 | 首次运行放行 8888(UDP)、19730(TCP)、9100(TCP) |







普通下载




您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关注公众号

相关侵权、举报、投诉及建议等,请发 E-mail:admin@discuz.vip

Powered by Discuz! X5.0 © 2001-2026 Discuz! Team.|浙ICP备19035960号-1

在本版发帖
关注公众号
QQ客服返回顶部