Files
Piik/docs/guide/getting-started.md
T
AAA a9b7507488 feat(app): add camera sharing and Host microphone controls
## Problem and outcome / 问题与结果

Add camera sharing and Host microphone commentary to the existing Host workflow,
with shared source cards, device selection, input gain and grouped sharing settings.
Browser and native capture keep one outgoing audio track and the existing room/media
owners. Include optional password-free invitations, public-tunnel protocol fallback,
capture retirement and App-discovery feedback fixes. This is the complete capture
maintenance phase; interaction, x86 capture and 4K experiments are excluded.

## Release notes

### 中文

这次更新让分享多了两种表达方式:用摄像头展示现场,用麦克风边分享边讲解。
分享设置也重新整理,并修复了公网邀请、音视频切换和采集退出中的一些问题。

#### 新功能与使用改进

- **摄像头分享**:在原有选源器中选择摄像头,支持设备选择和画面预览;支持摄像头访问的手机浏览器也可使用。
- **房主麦克风**:浏览器分享和 App 原生采集均可混入房主声音,支持选择麦克风、静音和输入音量调节。观众仍使用原有音量控件收听。
- **更集中的分享设置**:画质、声音和详细连接选项集中在画面下方,常用操作保持直接可用,并调整了窄屏播控与等待提示的布局。
- **邀请链接可选择是否免密加入**:关闭后,链接不再附带免密邀请;接收者按当前站点和房间的准入设置加入。
- **更清晰的启动设置**:可选站点口令默认收起,已有站点地址提供 `demo.piik.tv` 建议,并澄清 NAT 增强选项的含义。

#### 修复

- 公网邀请在 UDP 受限但 TCP 可用的网络中,可使用隧道组件原有的协议回退,减少这类启动失败。
- 调整音频时保留健康的视频发送;修复旧采集事件干扰当前分享的情况。
- 停止或取消原生采集时,先正常释放采集会话,超时才强制退出;修复本地复现的强制终止后 Windows 黄框残留问题。
- 从 App 打开的页面无法连接 App 时,选源器保留明确提示,不再只剩浏览器和摄像头选项而缺少原因说明。

#### 使用说明

摄像头和音频能力取决于系统、浏览器与设备。Windows 仍可能因权限或其他采集要求显示边框。
使用新增的 App 麦克风功能,请更新 App;连接自部署站点时,也请更新站点以获得对应页面功能。

### English

This update adds camera sharing and Host microphone commentary, alongside a
clearer sharing-settings layout. It also fixes several public-invitation,
audio/video transition and capture-shutdown issues.

#### Features and usability

- **Camera sharing:** choose a camera in the existing source picker, with device selection and thumbnail previews. Phone browsers with camera access can share too.
- **Host microphone:** add commentary to Browser sharing or App-native capture, with device selection, mute and input gain. Viewers listen through their existing volume controls.
- **Grouped sharing settings:** picture quality, sound and detailed connection options sit below the picture, while frequent actions remain directly available. Narrow-screen playback and waiting layouts are refined.
- **Optional password-free invitations:** turn this off to copy a link without an invitation credential. Recipients then follow the site's and room's current admission settings.
- **Clearer startup settings:** optional site-password settings are collapsed, the existing-site field suggests `demo.piik.tv`, and the NAT enhancement option has a clearer description.

#### Fixes

- Public invitations can use the tunnel component's existing protocol fallback when UDP is blocked but TCP is available, reducing startup failures on those networks.
- Audio changes preserve healthy video sending. Retired capture events no longer affect an active share.
- Stopping or cancelling native capture releases the capture session before enforcing the shutdown deadline. This fixes a locally reproduced case where forced termination left a Windows capture border behind.
- Pages opened from the App keep a clear connection warning in the source picker when the App cannot be reached, instead of showing only Browser and Camera without an explanation.

#### Usage notes

Camera and audio support depend on the OS, browser and device. Windows may still
require a border because of permissions or another active capture.
Update the App to use its new microphone feature; update self-hosted sites as
well to receive the matching page controls.

## Verification / 验证

- npm run check: 74 files / 1054 tests passed, TypeScript and production Web build passed.
- npm run check:go: Go tests, vet, target builds and Windows native compile/regressions passed.
- npm run gate:app-native-host: actual Windows H264 Host/Viewer, live/paused profile changes,
  quiet-source recovery, source replacement/failure, subsequent share and cleanup passed.
- Windows 11 capture-border check: parent cancellation retires the actual WGC session and
  clears its border; subprocess tests verify normal, concurrent and timed-out retirement.
- Website build, scripts typecheck, documentation and repository hygiene passed.
- Native macOS/Linux packaging and Linux race checks run in CI before publication.
  Physical phone camera and real audio-level/echo/multiple-device coverage remain recorded
  limits; the owner authorized release with those limits. No universal NAT/border fix is claimed.

## Impact / 影响

Compatible feature release **v1.6.0**, explicitly approved by the owner. Browser/Server v23,
Native control v9 and capture v7 stay unchanged; new App microphone commands use capability
negotiation. No new dependency, port, media route, room lifecycle or storage migration.
Published Server cutover retains configuration and room storage and uses bounded health
checks with the previous executable available for rollback. Source, tests and owned
documentation ship together; exact artifact/deployment identities remain outside the repo.
2026-09-21 18:34:56 +08:00

8.4 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

  1. Open the invitation link your friend sent in a desktop or mobile browser.
  2. Wait for their screen to appear. If the browser blocks autoplay, press Play.
  3. 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.

Hosts can turn off Skip passwords beside the link to copy the ordinary room address. Visitors follow the site's and room's access checks; invite-only rooms require the invitation credential. This switch does not revoke existing invites.

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

  1. Open demo.piik.tv in your browser.
  2. Select Start sharing, then Browser for a screen, window or tab, or Camera where your computer or phone browser supports it. Enable source audio if the picker offers it.
  3. Confirm the preview and select Copy invite link. Open that link on a second device or send it to a friend.
  4. 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

  1. Download a piik-app archive for your platform from GitHub Releases or the Gitee mirror. Extract the whole archive and keep its directory structure intact.
  2. Open piik-app.exe on Windows, Piik App.app on macOS, or ./piik-app on Linux. The launcher opens in your system browser.
  3. Choose Public invite for friends outside your local network, then select Open Piik. Other modes are explained below.
  4. Choose Start sharing, then select Browser, Camera, Apps / Windows, or Screens as available. Pick the actual source and sound option.
  5. 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 Local room and Public invite, expand Site passphrase to set an optional access passphrase.

For Connect to Site, enter the full site address, such as https://demo.piik.tv, then choose Open Piik. Enter the site's passphrase on the page that opens if asked. 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.

  1. Open your group's Piik site. Enter its site passphrase if asked.
  2. Choose Start sharing, then Browser to select a screen, window or tab in the browser picker, or Camera where your computer or phone browser supports it. Enable source audio if the picker offers it.
  3. Check the preview, then choose Copy invite link and send it to your friends.
  4. 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.

Add your voice

While sharing, select Microphone below the picture and allow microphone access. Select it again to mute. Open Sharing settings below the picture to choose a microphone and adjust its input volume. The default volume is 100%, with up to 200% available. Source audio and your voice reach viewers together. The Host preview stays muted.

Camera sharing does not enable the microphone automatically. App Apps / Windows and Screens capture use the same controls. Leave the device on Default device or choose a specific microphone. In the Camera tab, allow access if asked, then select a picture card to start sharing. Device names and previews depend on browser permissions; while a camera is shared, other cameras are listed by name. Use headphones to keep speaker sound from feeding back into the microphone.

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.