Waiting feedback and tooltips now share consistent presentation lifecycles, while App shutdown and native-media operation failures stay within their owning session or output. This phase also consolidates the project standards and publishes searchable English/Chinese reader documentation alongside the homepage. Validation: repository hygiene and Markdown links; TypeScript, 971 Web tests and production build; website/documentation build; Go tests, vet and Windows/Linux builds with Windows capture checks; desktop/mobile UI and documentation review. Linux race, container and three-platform packaging checks run in the release pipeline. Physical macOS/Linux capture and broader network coverage remain outside this acceptance. The owner approved v1.4.0 publication. Existing empty-source, Windows URL-handler and public-invitation timeout reports remain tracked; this release makes no claim to resolve those device/network reports. The Windows capture-border request is next-phase work. ## Release notes ### 中文 这是一次以稳定性和交互一致性为重点的功能更新。等待与提示更有反馈,App 启动、原生分享和连接恢复的边界处理得到改善,使用与部署指南也有了统一的文档中心。 #### 新增与改进 - 欢迎语、等待短句和六类可轮换的标签页标题共用一致的显示规则。等待短句从一开始就出现,并在停留时轮换;明确的错误与操作提示保持固定。 - 房间准入等漫画采用更克制的小人物与循环动效。改进 tooltip 的定位与指向,减少对播放器的遮挡;状态、图标和文案保持相同含义。 - 新增中英文文档中心,提供搜索、手机目录、使用教程、问题排查与自部署指南。官网 FAQ 聚焦开始使用前的问题,详细排查统一进入文档中心。 #### 修复 - 使用 `--local` 启动不再清空已保存的 Piik 站点地址。 - 打开系统浏览器不再阻塞 App 的退出流程;改进临时公网邀请、终端和诊断导出在关闭时的清理及错误反馈。 - 单条原生媒体连接的操作失败不再被误判为整个会话的协议错误;重复停止分享保持幂等。 - 修复连接替换、转发停止和异常退出时的部分资源清理问题,避免迟到结果影响当前连接。 - Windows 原生采集中,单个输出的编码错误只结束对应输出;共享采集源本身的错误仍会结束分享。 #### 升级与已知边界 本次保持现有协议版本与配置格式。更新 App 或自托管 Server 后,重新打开页面即可使用对应的新界面。 个别设备的空窗口列表、Windows 浏览器启动异常,以及 Linux 编码输出的故障隔离仍在跟进。macOS/Linux 的物理采集和更广泛的公网网络场景仍需实机验证;本次不宣称这些问题已经解决,也不承诺所有网络都能直连。 ### English This feature update focuses on stability and consistent feedback. Waiting states are easier to follow, App startup and native sharing handle several failure cases more reliably, and the new documentation center brings usage and deployment guides together. #### New and improved - Welcome lines, waiting captions and six groups of rotating tab titles follow one presentation lifecycle. Waiting captions appear immediately and rotate while visible; actionable errors and instructions remain fixed. - Room-admission comics use restrained characters and looping motion. Tooltips point more accurately to their controls and interfere less with the player, with consistent meanings across illustrations, icons and copy. - A new English/Chinese documentation center includes search, mobile navigation, usage guides, troubleshooting and self-hosting. The homepage FAQ covers questions before getting started and links to the documentation for detailed help. #### Fixes - Starting with `--local` no longer clears a saved Piik site address. - Opening the system browser no longer blocks App shutdown. Temporary public invitations, the terminal and diagnostic exports handle cleanup and exit errors more consistently. - An operation failure on one native media connection no longer becomes a protocol failure for the entire session. Repeated stop-sharing requests are safe. - Fixed cleanup cases during connection replacement, relay shutdown and unexpected exits, preventing late results from affecting the current connection. - On Windows, an encoder failure for one native output stops that output only. A failure of the shared capture source still ends sharing. #### Updating and known limits Protocol versions and configuration formats are unchanged. After updating the App or your self-hosted Server, reopen the page to use its updated interface. Empty source lists on some devices, Windows browser-launch failures and Linux output-failure isolation remain under investigation. Physical macOS/Linux capture and broader public-network coverage still need device testing; this update does not claim to resolve those cases or guarantee a direct connection on every network.
6.4 KiB
Embedded Media Evaluation
Reviewed: 2026-09-07. Status: evaluation, not a deployed transport decision.
Baseline: 3da8ecd22a3499e660f498e527ad4ffbaef08c82.
Goal
The owner requests source/library-level STUN and SFU inside the Piik Go process. Bundled coturn/LiveKit executables, automatic installers, subprocess supervision and embedding the full LiveKit service do not meet this goal. The owner has also agreed to node-local adaptive reuse: each parent derives missing lower outputs for its direct children and reuses them locally. That file owns the agreed model and unresolved encoding policy. nginx/TLS replacement and capture-picker changes are outside this experiment. The existing release/configuration candidate remains separate and untouched.
Invariants
Keep one room authority and the P2P-first, single-graph, single-operation router. The fallback retains one Host publication feeding server-side fanout to many Viewers. Framework-managed simulcast may use bounded representations within that publication; Viewer count must not add Host encoders or independent Host uploads. Ordinary TURN forwarding of one Host connection per Viewer does not meet this requirement and is not an SFU replacement candidate. Retain H264/VP8, Opus, per-subscriber adaptation, retransmission, recovery and the existing three STUN destinations. Do not trade weak-Viewer experience for a smaller package, invent an application quality score or add a media ladder. The media library, not Piik, must own congestion and layer decisions. No recording, mixing, TURN relay, public port scanning or production test. Selective local transcoding is now in research scope under the agreed model; the existing fanout-only probe does not establish that capability.
Evaluation Order
- Audit library APIs, license, dependencies and H264/simulcast feedback paths.
- Implement a small in-process STUN owner using Pion. Check Binding responses, no relay allocation, occupied-port rollback and complete socket shutdown.
- Exercise one publisher and two receivers through an SFU library on loopback. Check fixed Host publication count, actual media, clean teardown and the library's adaptation ownership; frame forwarding alone is not acceptance of a LiveKit replacement.
- Compare added dependencies and binary size, then remove unnecessary glue. A production adapter/wire cutover needs a decision supported by these results.
No new production dependency or alternate runtime transport is accepted merely
because its example compiles. Keep test executables under the worktree's stable
build/ path and avoid native GPU capture probes.
Initial Candidates
- Pion STUN/TURN is already in the dependency graph and explicitly supports embedding. Only STUN is needed; TURN allocations must remain unavailable.
- ion-sfu is library-oriented, but its inspected module still uses Pion WebRTC v3 and ICE v2. Do not introduce another older media stack by default.
- inlivedev/sfu uses Pion WebRTC v4 and exposes room/client APIs. Its README explicitly warns that its API is early-stage; listed features are claims to verify, not proof of Piik's required behavior.
- Galene is useful architectural reference, not yet an accepted library adapter.
Current Evidence
- The 2026-09-07 local STUN check passed three independent Binding responses, zero TURN allocations, port release on shutdown and occupied-port rollback. The adapter uses Pion's existing STUN-only server, not a new STUN parser.
inlivedev/sfuis pinned for evaluation atv0.0.0-20260307060053-14b2448a8982(MIT). A loopback Pion publisher with one H264 RTP sender fed two receivers, each receiving 12 RTP packets in the check. No extra Host sender was created for the second receiver. The source was a synthetic 2x2 H264 sample, so this is not Browser decode, game quality, latency, resource-drain or adaptive-layer acceptance.- The candidate is imported only by the probe test. There is no production
adapter or signaling change. Its dependency graph also adds TURN v4 alongside
the existing v5 and upgrades
x/netfrom 0.50.0 to 0.51.0; evaluate that cost before selecting it. No fork or patch of the library has been introduced. - Candidate source contains Pion GCC, RTCP feedback and simulcast switching. It also requires publisher-layer/bitrate agreement and has application-oriented defaults. A demand-driven publisher contract equivalent to our current behavior has not yet been established. README feature lists alone do not close this gap.
Those results came from the evaluation revision; its sfuprobe package is not
retained in current source. Do not run that
old package path against current source. Current STUN and SFU validation uses
the maintained verification entry points.
Transport Direction
One-to-many distribution is not tied to the LiveKit implementation. Keep WebRTC as the primary Browser media path while evaluating a lighter embedded engine. RTMP/RTSP/SRT distribution can also fan out one input, but a Browser-facing gateway/player pipeline and equivalent media adaptation would still be needed. Do not add that second transport merely to change the service's name.
WHIP is HTTP signaling for WebRTC ingest, not a replacement media transport. Its no-renegotiation constraint must be checked against live audio/source changes; it is not adopted merely because the request/response looks simpler. The current Piik signaling owner remains authoritative during this evaluation.
Sources
- Pion embeddable STUN/TURN
- ion-sfu module
- inLive SFU API and caveats
- inLive dependency contract
- Galene architecture
- Browser-facing MediaMTX playback
- SRT protocol
- WHIP media and signaling contract
中文范围
本阶段是库级替换实验,不是把外部程序藏进安装包。先核实成熟模块能否保持 现有观影体验,再决定接入。仅转发成功不代表自动降级、重传和恢复已验收; 必须保留一次 Host 发布、服务端多观众分发;不能用逐观众 TURN 上行替代。 尚未修改生产路由、协议或部署。