Files
acfunlive-remake/doc/webapi.md
T
tamakyi 237fffa8fe 录制档位改成「最高/第二高/最低/自定义」四种相对偏好,没开播也能先设
上一版的下拉里列的是「这次读到的实际档位」,没读到档位表(没开播)时下拉里就只剩
一项,想预先设「我要最高档」或「最低档」都做不到。改成按「实际档位里的第几档」来选:

- 新增 `qualityPref`:top(最高档)/ second(第二高,默认)/ lowest(最低档)/
  custom(取不超过给定码率的最高档,都比它高时退回最低档)。四种偏好任何时候都
  在列表里,开播后自动对应到实际档位;读到档位表后把对应结果标在选项后面
  (`第二高(蓝光 4M)`、`自定义(≤2500K = 高清)`)。
- `bitrate` 只在 custom 时有意义。`resolveQualityBitrate(tiers, pref, custom)` 统一
  解析:相对偏好没有档位表时返回 0(取流退回最高档),custom 返回填的上限。
  解析只在取流时做,所以主播换了档位表,偏好会跟着一起变。
- 老配置兼容:没有 qualityPref 时,`bitrate > 0` 当成 custom(就是原来的「码率上限」,
  行为不变),`bitrate == 0` 当成默认的第二高;在 checkConfig 里补齐(不写盘,下次
  保存自然带上)。`setBitrate` 相应换成 `setQuality(uid, pref, custom)`。
- 页面:选 custom 时旁边出现码率框,初始值就是**当前实际在用的那一档**(不会一切过去
  就掉到最低档),回车或失焦即提交,填错给提示并回填服务端的值;从 custom 切到别的
  档位不带 bitrate,服务端保留原值,改回来还是原来那个数。
- 设置区同步:新主播的默认档位也用同一套四项(`defaultQualityPref`),只有选自定义
  才露出码率上限框(切过去会补一个能用的 3000,免得新主播默默用最低档)。

顺带修一个脚本抓到的真 bug:档位名传成了档位对象(`esc()` 里会 `.replace`),只要
档位表非空就会抛异常,而 refresh() 整段包在 try/catch 里 —— 表现是整个主播列表
变成空白且没有任何报错。现在取的是 `qs[i].name`。

测试:qualities_test.go 重写 TestResolveQualityBitrate(10 种偏好/码率组合)并新增
TestMigrateQualityPref、TestUpgradeQualityPrefs、TestSetQuality;verify_streamer_br.py
改成带迷你后端的假服务(POST 会真正落到假状态上),30 项断言全过;verify_qualities.py
25 项(含设置区与 config.json 往返)全过;verify_settings.py / verify_pick.py /
verify_danmu_match.py 无回归;go test ./...、gofmt、go vet 干净。
2026-09-25 20:42:22 +08:00

12 KiB
Raw Blame History

acfunlive web API

web API 默认本地端口为 51880

http://localhost:51880/listlive 列出正在直播的主播

http://localhost:51880/listrecord 列出正在下载的直播视频

http://localhost:51880/listdanmu 列出正在下载的直播弹幕

http://localhost:51880/liststreamer 列出设置了开播提醒或自动下载直播的主播

http://localhost:51880/startmirai 利用 Mirai 发送直播通知到指定 QQ 或 QQ 群

http://localhost:51880/addnotifyon/23682490 通知 uid 为 23682490 的主播的开播

http://localhost:51880/delnotifyon/23682490 取消通知 uid 为 23682490 的主播的开播

http://localhost:51880/addnotifyoff/23682490 通知 uid 为 23682490 的主播的下播

http://localhost:51880/delnotifyoff/23682490 取消通知 uid 为 23682490 的主播的下播

http://localhost:51880/addnotifyrecord/23682490 通知 uid 为 23682490 的主播的直播视频下载

http://localhost:51880/delnotifyrecord/23682490 取消通知 uid 为 23682490 的主播的直播视频下载

http://localhost:51880/addnotifydanmu/23682490 通知 uid 为 23682490 的主播的直播弹幕下载

http://localhost:51880/delnotifydanmu/23682490 取消通知 uid 为 23682490 的主播的直播弹幕下载

http://localhost:51880/addrecord/23682490 uid 为 23682490 的主播直播时自动下载其直播视频

http://localhost:51880/delrecord/23682490 取消自动下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/adddanmu/23682490 uid 为 23682490 的主播直播时自动下载其直播弹幕

http://localhost:51880/deldanmu/23682490 取消自动下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/addkeeponline/23682490 uid 为 23682490 的主播直播时在其直播间里挂机

http://localhost:51880/delkeeponline/23682490 取消设置在 uid 为 23682490 的主播直播时在其直播间里挂机

http://localhost:51880/delconfig/23682490 删除 uid 为 23682490 的主播的所有设置

http://localhost:51880/getdlurl/23682490 查看 uid 为 23682490 的主播是否在直播,并输出其直播源

http://localhost:51880/addqq/23682490/12345 将 uid 为 23682490 的主播的开播提醒发送到 QQ12345,需要 QQ 机器人已经添加该 QQ 为好友

http://localhost:51880/delqq/23682490/12345 取消将 uid 为 23682490 的主播的开播提醒发送到 QQ12345

http://localhost:51880/cancelqq/23682490 取消将 uid 为 23682490 的主播的开播提醒发送到任何 QQ

http://localhost:51880/addqqgroup/23682490/12345 将 uid 为 23682490 的主播的开播提醒发送到 QQ 群 12345,需要 QQ 机器人已经加入该 QQ 群,最好是管理员,会@全体成员

http://localhost:51880/delqqgroup/23682490/12345 取消将 uid 为 23682490 的主播的开播提醒发送到 QQ 群 12345

http://localhost:51880/cancelqqgroup/23682490 取消将 uid 为 23682490 的主播的开播提醒发送到任何 QQ 群

http://localhost:51880/startrecord/23682490 临时下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/stoprecord/23682490 取消下载 uid 为 23682490 的主播的直播视频

http://localhost:51880/startdanmu/23682490 临时下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/stopdanmu/23682490 取消下载 uid 为 23682490 的主播的直播弹幕

http://localhost:51880/startrecdan/23682490 临时下载 uid 为 23682490 的主播的直播视频和弹幕

http://localhost:51880/stoprecdan/23682490 取消下载 uid 为 23682490 的主播的直播视频和弹幕

http://localhost:51880/log 查看 log

http://localhost:51880/quit 退出 acfunlive 运行

http://localhost:51880/help 显示帮助信息

新版 web UI 的管理接口

web UI(-webui,端口看webPort)用的是另一套/api/接口,全部需要带管理口令:请求头X-Auth-Token: <口令>,或者在 URL 上带?token=<口令>(下载链接用后者,因为浏览器跳转带不了请求头)。

口令支持任意字符,包括中文——不过 HTTP 请求头只接受 ISO-8859-1,浏览器遇到非 ASCII 的口令会直接拒绝发请求(报String contains non ISO-8859-1 code point),所以页面发给服务端的X-Auth-Token是百分号编码过的口令(encodeURIComponent)。服务端两种写法都认:先拿原样比,再拿解码后的比,所以手写 curl 或者脚本按原样把中文口令放进请求头、Authorization: Bearer、?token= 里也都能通过。用脚本调这套接口时不用管编码,原样填就行。

GET /api/streamer/qualities?uid=<uid> 去直播间接一次该主播的码率档位(返回{"uid":…,"qualities":[{"name":"蓝光 4M","bitrate":4000},…],"qualityPref":"second","bitrate":0,"qualityBitrate":实际会用到的档位码率,"qualityName":实际会用到的档位名},qualities按码率从高到低)。读到的档位会缓存进config.json(没开播时页面靠它把偏好标成具体档位名),但不会改动用户选的偏好。同一个主播 10 秒内只让读一次,太频繁返回 502 并给中文原因(没开播时也会返回 502,且没开播时服务端本来就要重试三次,页面上会先给一句正在读取码率档位…)。

POST /api/streamer里的qualityPref是按第几档来选,而不是写死码率:top(最高档)、second(第二高,默认)、lowest(最低档)、custom(取不超过bitrate的最高档,都比它高时退回最低档)。四种偏好任何时候都能设,开播后自动对应到实际档位。bitrate只在custom时有意义:已存在的主播不传就保持原值(页面从最高档切到别的档位时不会把填过的自定义码率清掉)。GET /api/status里每个主播的qualities是缓存的档位表,qualityPref/bitrate是用户选的,qualityBitrate/qualityName是按偏好解析出来的结果(还没读到档位表时,前三种偏好解析为 0、custom解析为填的上限)。

跟手动合并有关的是下面三个: GET /api/merge/danmu?video=<视频文件名或路径> 按视频名找同目录下的同名弹幕文件,给页面「选好视频自动匹配弹幕」用。依次试.jsonl、.ass、.nick.ass,同目录没有就拿文件名去录播目录再找一次;返回{"danmu":"…"},找不到时是空字符串。值里录播目录/成片目录下的文件只写文件名,别处的写绝对路径,和浏览弹窗的填法一致。

POST /api/merge/info 预览一次手动合并的计划,不落盘。

{
    "videos": ["2026-09-25 01-00-00 主播 标题.mp4", "D:/别处/随手放的视频.mp4"],
    "danmu": "2026-09-25 01-00-00 主播 标题.ass",
    "offset": 3                // 可选,不填按文件名里的录制时间推算
}

返回分段列表(名字、体积、时长、是否正在写入)、总时长、弹幕条数、弹幕时间范围、要用的弹幕文件和来源(jsonl 弹幕数据 / 同名的 jsonl 弹幕数据 / 由 xxx.ass 还原)、推算出的偏移和原因、最终输出文件名、以及提示(warnings)。参数不合法一律 400,并在响应体里给中文原因。

POST /api/merge 真正开始合并,请求体和上面一样,另外可以带outName指定输出文件名(不合法会被清理成安全的文件名,重名自动加后缀)。成功后立刻返回{"outName":"…"},合并在后台跑。已经有一个手动合并任务在跑时返回 409。合并完成也会触发一次推送(和自动合并同一个mergeDone事件):手动合并没有 uid,会拿成片或视频的文件名去对已有的主播名,只有一个能对上时才在文案里带上主播名,对不上就用手动合并完成。

合并状态通过GET /api/status查看:mergeBusy(是否在跑)、mergeOutName(当前成片名)、mergeErr(失败原因)、mergeDoneAt(上次完成时间)。合并期间成片会出现在GET /api/files里且inUse为 true,此时POST /api/file/remove会返回 409 拒绝删除。

POST /api/config里的danmuFontSize控制合并时弹幕文字的字号(像素),头像按同一比例缩放,填 0 表示沿用弹幕文件里记的字号。渲染前会按最终字号重排弹道:从上游原版.ass还原出来的弹幕只按内容宽度占位,而渲染用的是「昵称(uid):内容 + 头像」的完整宽度,占位时间更长,照搬原弹道会追尾叠字;重排按完整宽度重新分配,同一条弹道上不会再有两条弹幕叠在一起。

mergeBitrate填 0(默认)时按「源片码率 + 500 Kbps」自动计算:先探测视频流的码率,加 500 留给烧进去的弹幕;探测不到就退回质量模式。填大于 0 的值则按该码率固定输出。编码器优先硬件 HEVC(hevc_qsv,同画质比 H.264 省约三成体积,mp4 里打hvc1标记),不支持时回退h264_qsv、libx264,日志里会打印实际用的那一个。

POST /api/notify/test 测试某个推送渠道能不能连通。用传进来的值直接测,留空的项自动用已保存的配置补齐,所以不用先保存设置。测试不受渠道开关和事件勾选影响。

// QQ 机器人(webhook)渠道,channel 不填就按这个
{ "channel": "qq", "url": "http://127.0.0.1:8080/acfunlive/notify", "token": "可选", "group": "可选" }
// MeoW 渠道
{ "channel": "meow", "nickname": "你的昵称", "msgType": "text", "imgUrl": "可选", "htmlHeight": 200 }

成功后返回{"ok":true,"detail":"webhook 返回 HTTP 200,用时 0.31 秒。…"},detail就是页面上显示的那句结论。失败时返回 502 并在响应体里给中文原因(如MeoW 返回 status 404(昵称未注册)),参数不合法返回 400。

MeoW 的status和封禁规则会反映在GET /api/status的meowBlocked字段里:昵称没填、格式不对、或已被 MeoW 判过「未注册」时,这里会给出中文原因,非空就说明 MeoW 渠道当前推不出去。注意 MeoW 一天内累计 3 次推给不存在的昵称会封 IP,所以被判过不存在的昵称会被程序记住并停止重试,改昵称或重启程序才恢复。

GET /api/browse 给页面上的浏览按钮列目录用。参数:path(要展开的目录,不填就用程序当前的工作目录)、kind=file(连文件一起列,挑文件时用)、hidden=1(连以点开头的隐藏项一起列)。页面上的浏览有单选(保存目录、ffmpeg 路径、弹幕文件)和多选(手动合并的视频文件)两种用法,接口每次只负责列一层,多选的勾选状态由页面自己保管,所以可以换着目录勾、跨文件夹攒;填回框里时,录播目录下的文件写文件名、别的文件夹里的写绝对路径。

{
    "path": "D:\\record",                                     // 当前展开的目录,已转成绝对路径
    "parent": "D:\\",                                         // 上级目录,已经到根时是空串
    "roots": [{"name": "C:", "path": "C:\\", "dir": true, "size": 0}],
    "entries": [{"name": "2026-09-25.mp4", "path": "D:\\record\\2026-09-25.mp4", "dir": false, "size": 123}],
    "truncated": false,                                       // 条目太多时只返回前 2000 项
    "error": ""                                               // 打不开时的中文原因
}

文件夹排在文件前面,同类按名字排(不区分大小写)。挑文件时文件夹照样会列出来,不然进不去子目录。error非空时仍是 HTTP 200,entries是空的,但parent会带上——页面据此退到上一级,不会把用户卡在一个打不开的路径里(比如把文件路径当目录展开时)。

这个接口能看到整台机器的目录,但权限和其它管理接口一样,都是拿到口令即全部权限,没有放宽。