Files
Piik/docs/guide/getting-started.zh-CN.md
T
AAA 799d6efb4a fix: improve sharing recovery and UI feedback
## Problem and outcome / 问题与结果

Browser sharing can remain connected to a local encoding transport that never becomes usable, leaving viewers without frames. This phase bounds that startup at eight seconds and restores ordinary encoding through the existing failure path. It also keeps ready App services running after a browser-open failure, preserves user presentation/playback choices, and aligns room feedback, illustrated hints, metrics and documentation.

部分环境下,本机编码连接一直无法建立会让观众收不到画面。本轮在八秒后进入现有降级流程,同时修复客户端启动移交、播放状态和前端反馈的一致性问题,并更新官网与中英文教程。

Closes #399.

Related: #396. The release contains relevant startup/error-handling repairs, but the reporting machine has not been retested. Keep this issue open for a current-build result. #401 (optional Windows capture-border hiding) remains deferred.

Release / 发布版本:**v1.3.1**.

## Release notes

### 中文

- 客户端记住上次确认的启动模式;启动移交保留已保存的语言、纯视觉模式和主题选择。
- 系统浏览器未能自动打开时,客户端继续运行,并在终端保留页面地址、重试入口和具体错误。
- 改善浏览器共享画面的启动兜底,避免 App 媒体因短暂信令中断被误判为失败。
- 音轨变化保持现有视频与观众的本机暂停状态;连接恢复和暂停恢复不再重复播放电视开机动画。
- 修复昵称编辑及长昵称查看,减少重复的角色提示,统一人物选择和连接状态的区别。
- 完善房间准入、密码和邀请说明;复制反馈对应当前链接及当前操作,避免迟到结果覆盖新反馈。
- 修正采集参数、统计单位与采样区间的展示,未知参数不再用配置上限代替。
- 统一提示漫画、状态图标与动效,改善选源器还焦、键盘操作、剧场布局和触控目标尺寸。
- 服务端默认支持 20 位观众,可在配置中设为 1–20 位,房主不占观众名额。
- 更新官网、教程入口和中英文说明,清理过时预览及失用代码。

兼容说明:使用旧版 App 连接更新后的站点时,站点会优先保留自己的显示偏好。如需更改语言或主题,请在进入后的页面调整。

### English

- Remember the last confirmed App launch mode and preserve saved language, visual-mode and theme choices during launch handoff.
- Keep the App running if the system browser fails to open, with the page address, retry action and error details available in the terminal.
- Improve the browser sharing startup fallback and avoid treating brief signaling outages as App media failures.
- Keep existing video and local pause state when audio tracks change. Reconnecting and resuming no longer replay the television startup animation over the picture.
- Fix nickname editing and full-name access, remove redundant role hints, and distinguish participant selection from connection state.
- Clarify room access, passwords and invitations. Copy feedback now belongs to the current link and operation, so late results cannot replace newer feedback.
- Correct capture details, metric units and observation intervals. Unknown capture values are no longer replaced with configured ceilings.
- Align illustrated hints, status icons and motion. Improve source-picker focus, keyboard operation, theater layout and touch targets.
- Default the Server to 20 viewers, configurable from 1 to 20. The host does not count toward that limit.
- Update the website, guide links and bilingual instructions, and remove obsolete previews and unused code.

Compatibility: when an older App connects to an updated Site, the Site keeps its saved presentation preferences. Change language or theme on the destination page when using an older launcher.

## Verification / 验证

Non-publishing [CI candidate run 34919320511](https://github.com/TNTcraftHIM/Piik/actions/runs/34919320511) passed Go core, race, Web checks, Server/container verification and all three native App package checks at source 188376e8. Subsequent commits only update deployment documentation, status and TODO; documentation/hygiene checks passed. Product inputs are unchanged.

- `npm run check`: TypeScript, 64 test files / 854 tests, and the Web production build passed.
- `npm run check:client-core`: final Go source passed tests, formatting, vet and core target builds. Windows capture compilation and geometry checks passed earlier in this phase; later edits did not change native capture.
- Website build, documentation checks, repository hygiene and diff checks passed. Existing documentation-size and bundle-size warnings remain.
- Actual browser flows covered sharing, source changes, pause/resume, late audio, brief signaling loss, invitation/copy feedback, entry preferences, source-picker focus, and narrow layouts.
- A local three-viewer P2P relay check covered quality-report expiry, recovery and cleanup without interrupting video. A controlled browser-helper failure returning `0xc0000005` left the real App launcher and Local service available.
- Homepage checks covered Chinese/English, light/dark preferences and inline-film open/close after removing the separate-page entry.

Limits: no new reporter-machine confirmation for #396 or the Windows URL-handler crash; physical Safari/mobile, macOS/Linux capture and wider public-network/endurance coverage remain deferred. Formal release artifacts will be built from the approved squash-merge revision. Hero-loop controls and video-adjacent tooltip placement remain open design items in TODO.

## Impact / 影响

Compatible patch; signaling, Native control and capture contracts are unchanged. Older App launch handoff keeps the updated Site's saved presentation preferences. The Server's default viewer limit is corrected to 20; an explicit 1–20 configuration remains valid.

Service updates retain persisted room authority but restart active media sessions. Deploy the verified immutable Server artifact through the existing bounded health/recovery process. Public Demo remains open and P2P-only; deployment does not enable SFU or change infrastructure/configuration.
2026-09-15 10:13:29 +08:00

7.3 KiB
Raw Blame History

第一次用 Piik

English · 简体中文 · 回到 Piik

Piik 支持一位房主分享屏幕,最多 20 位受邀观众通过浏览器观看。 本指南介绍加入房间、使用在线版、使用客户端,以及通过已有站点分享的方法。

加入房间 · 在线版 · Piik App · 已有站点 · 问题排查

观众只需要浏览器和邀请链接。 分享画面推荐下载 Piik App,选择 公网邀请。 想免安装,可以打开在线版,直接在浏览器里创建房间并分享。

加入朋友的房间

  1. 用电脑或手机浏览器打开朋友发来的邀请链接。
  2. 等待画面出现。如果浏览器没有自动播放,点击 播放。
  3. 将鼠标移到画面上,或轻点画面,显示播放控制栏。

播放控制栏只改变你自己看到的画面和听到的声音。 电脑上单击画面可暂停或继续,双击可进入或退出全屏(浏览器支持时)。 手机上轻点画面唤出控制栏,再使用其中的按钮。Safari 的视频全屏可能使用系统播控。

播放按钮分别做什么?
按钮 作用
剧场模式 在浏览器标签页内展开画面。
全屏观看 让画面铺满屏幕。
悬浮小窗 浏览器支持时,把视频放进独立小窗。
音量 支持增强时最高 200%,否则最高 100%;声音失真时调低一些。

只有四位房间号时,打开同一个 Piik 站点,选择 加入房间。 你可能需要站点口令和房间密码。能否通过房间号加入由房主决定; 无法加入时,请朋友发邀请链接。

旧链接失效了,就请房主重新发一份当前邀请。 App 的本地房间和临时公网邀请会随本次 App 退出而结束。

使用在线版

  1. 在支持屏幕共享的电脑浏览器中打开 demo.piik.tv。
  2. 点击 开始分享,选择屏幕、窗口或标签页;如需声音且浏览器提供该选项,启用音频。
  3. 确认预览后,点击 复制邀请链接,用另一台设备打开,或发送给朋友。
  4. 分享结束后,点击 停止分享。

在线版由项目提供,画面仅通过设备间直连(P2P)传输。 在受限网络下,可能出现页面能打开、画面无法连接的情况。

用 Piik App 分享

  1. 从 GitHub Releases 或 Gitee 镜像下载以 piik-app 开头、 对应平台的压缩包,完整解压并保留目录结构。
  2. Windows 打开 piik-app.exe,macOS 打开 Piik App.app,Linux 运行 ./piik-app。 启动页会在系统浏览器里打开。
  3. 邀请不在同一局域网的朋友时,选择 公网邀请,再点击 进入 Piik。 其他模式的用途见下表。
  4. 点击 开始分享,按可用选项选择 浏览器、程序 / 窗口 或 屏幕, 然后选定要分享的画面与声音。
  5. 复制房间邀请发给朋友。分享期间保持 App 和分享标签页打开。
文件名包含 适用平台
windows-amd64 Windows x64
darwin-arm64 Apple 芯片;原生采集需 macOS 13 及以上
linux-amd64 Linux x64

目前主要测试 Windows 客户端和浏览器分享。macOS 和 Linux 客户端尚未经过实机测试, 欢迎有设备的朋友试用并反馈问题。 Linux 原生采集还需要系统组件。 程序包与启动参数的细节见 App 指南。

选择 App 模式

模式 什么时候用 需要知道
本地房间 朋友和你在同一个局域网。 出现多个「局域网邀请地址」时,选择与朋友同一网络的网卡和 IP。对方需要能连接到你的电脑,可以设置本地站点口令。
公网邀请 朋友在别处,想临时发个邀请。 需要互联网连接;公网地址只在本次 App 运行期间有效。
连接站点 你们已经有一个 Piik 站点。 输入站点地址,在原有分享页面使用 App 的采集能力。

网页能打开,不代表视频一定能连通。 公网邀请为房间提供临时网页地址, 画面和声音仍靠参与者之间的连接传输。此模式没有媒体服务器兜底, 临时地址也不保证持续可用。所有模式都需要可用的 UDP 媒体路径。 具体连接方式见 App 指南。

用浏览器分享

需要先有一个运行 Piik Server 的 HTTPS 站点,可以使用朋友或管理员提供的地址。 也可以使用项目提供的在线版或客户端。 自建站点属于进阶操作,服务器、HTTPS 和网络端口的配置步骤见部署指南。

  1. 在电脑上打开 Piik 站点。如果站点设置了口令,先输入口令。
  2. 点击 开始分享,在浏览器弹窗里选择屏幕、窗口或标签页; 如需声音且浏览器提供该选项,启用音频。
  3. 确认预览画面后,点击 复制邀请链接 发给朋友。
  4. 保持分享标签页打开。需要时使用 暂停分享、切换来源 或 停止分享。

浏览器屏幕采集需要 HTTPS 站点或 localhost。 弹窗里有哪些画面和声音可选,取决于浏览器与操作系统。 拿到邀请链接的人可以进入这个房间,请把它发给你想邀请的人。

遇到问题了

你遇到的情况 可以先试什么
有画面,没声音 先取消视频静音。房主应选择支持分享声音的来源;如果开始时关闭了声音,请停止后重新开始并打开声音。通过 App 采集窗口或屏幕时,切换来源会保留原来的声音设置。
没有屏幕选择弹窗 按系统提示允许浏览器或 App 录制屏幕。浏览器采集需要 HTTPS 或 localhost,请在电脑上尝试分享。
App 启动失败 先查看页面和终端中的具体原因。重新打开 App,在主题按钮后的芯片图标开启「诊断启动」再重试。启动失败时会自动导出报告,保存位置见终端。
本地邀请打不开 确认两台设备在同一网络且可以互相访问。访客 Wi-Fi 或防火墙规则可能阻止本地连接。
网页能打开,画面连不上 点击播放控制栏的 重新连接;仍然失败时,检查 WebRTC 连接设置,或尝试有媒体服务器兜底的站点。
休眠或挂起后分享中断 唤醒设备,回到分享标签页,必要时重新开始分享。浏览器或系统挂起可能中断采集和播放。

反馈问题时,请附上版本、系统与浏览器、预期结果和复现步骤。 诊断与导出 说明如何收集本地报告,以及分享前需要检查哪些内容。

想为朋友搭一个站点?从 部署指南 开始。 其他内容可在 文档导航 找到。