AAA
cdd503a98d
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.
7.1 KiB
Your first Piik room
English · 简体中文 · Back to Piik
Piik shares one person's screen with up to 20 invited viewers. This guide covers watching, using Piik online, using Piik App and sharing through an existing site.
Join a room · Use online · Piik App · Existing site · Troubleshooting
Viewers need a browser and an invitation. To start sharing, download Piik App and choose Public invite. To share without installing, open Piik online and create a room in your browser.
Join a friend's room
- Open the invitation link your friend sent in a desktop or mobile browser.
- Wait for their screen to appear. If the browser blocks autoplay, press Play.
- Move the pointer over the picture or tap it to show the playback bar.
The playback bar controls only your own picture and sound. On a computer, click the picture to pause or resume; double-click to enter or leave fullscreen where supported. On a phone, tap the picture to show the bar and use its buttons. Safari may show system controls in video fullscreen.
Playback controls, at a glance
| Control | What it does |
|---|---|
| Theater mode | Expands the picture inside the browser tab. |
| Fullscreen | Fills your screen. |
| Picture in picture | Opens a floating video where supported. |
| Volume | Goes up to 200% with audio boost, or 100% otherwise. Lower it if the sound distorts. |
With just a four-digit room code, open the same Piik site and choose Join a room. You may need the site's passphrase and the room's password. The host decides whether code entry is available; ask for an invitation link if you cannot join by code.
If an old link no longer works, ask the host for the current invitation. App Local rooms and temporary public invitations end when that App run stops.
Use Piik online
- Open demo.piik.tv in a desktop browser that supports screen sharing.
- Select Start sharing, choose a screen, window or tab, and enable audio if needed and offered by the browser.
- Confirm the preview and select Copy invite link. Open that link on a second device or send it to a friend.
- Select Stop sharing when finished.
The online version is provided by the project. Media travels only between participants (P2P); restrictive networks may load the page but block video.
Share with Piik App
- Download a
piik-apparchive for your platform from GitHub Releases or the Gitee mirror. Extract the whole archive and keep its directory structure intact. - Open
piik-app.exeon Windows,Piik App.appon macOS, or./piik-appon Linux. The launcher opens in your system browser. - Choose Public invite for friends outside your local network, then select Open Piik. Other modes are explained below.
- Choose Start sharing, then select Browser, Apps / Windows, or Screens as available. Pick the actual source and sound option.
- Copy and send the room invitation. Keep both the App and sharing tab open.
| Filename contains | Platform |
|---|---|
windows-amd64 |
Windows x64 |
darwin-arm64 |
Apple silicon; native capture requires macOS 13+ |
linux-amd64 |
Linux x64 |
Windows App and browser sharing are the primary tested paths. The macOS and Linux apps have not yet been tested on physical devices; test results and feedback are welcome. Linux native capture also needs system components. See the App guide for package and runtime details.
Choose an App mode
| Mode | When to choose it | What to keep in mind |
|---|---|---|
| Local room | Friends are on the same local network. | If several entries appear under Local invitation address, choose the interface and IP on your friends' network. Your computer must be reachable from theirs. A local site passphrase is optional. |
| Public invite | Friends are elsewhere and you want a temporary invitation. | Needs Internet access. The public address lasts for this App run. |
| Connect to Site | Your group already has a Piik site. | Enter its address; the App adds capture capabilities to the site's sharing page. |
For Connect to Site, enter the full site address, such as
https://demo.piik.tv, add its passphrase if required, then choose Open Piik.
After opening the site through the App once, the same browser remembers that
entry. Keep the App running with that site configured and you can visit the
address directly. Start sharing opens the selector; choose Apps / Windows
or Screens for App capture. Allow local-network access if the browser asks.
In another browser, in a private window, or after clearing site data, enter through
the App again. For a different site, update the address in the App first.
A page that opens does not guarantee a video connection. Public invite gives your room a temporary web address; picture and sound still travel between participants. This mode has no media-server fallback, and the temporary address has no uptime guarantee. All modes need a working UDP media path. The App guide explains the connection setup.
Share from an existing site
You need an existing HTTPS site running Piik Server, provided by a friend or administrator. You can also use Piik online or Piik App. Hosting a site yourself is an advanced option: follow the self-hosting guide for server, HTTPS and network setup.
- Open your group's Piik site on your computer. Enter its site passphrase if asked.
- Choose Start sharing. In the browser picker, select the screen, window or tab you want friends to see, and enable audio if offered.
- Check the preview, then choose Copy invite link and send it to your friends.
- Keep the sharing tab open. Use Pause sharing, Switch source, or Stop sharing when you need them.
Screen capture requires an HTTPS site or localhost. The sources and audio
offered by the picker depend on your browser and operating system.
Invitation links grant access to that room; share them with the people you want there.
To use App capture on that same site, follow Connect to Site. The site manages rooms and invitations; the App supplies native capture. If its operator has enabled SFU forwarding, turn off Privacy mode before sharing to allow that fallback. The project's online site uses P2P only.
When something gets in the way
For sound, capture, startup or playback issues, see Troubleshooting.
When video will not connect
See connection troubleshooting for “No media route available” and similar connection failures.