Files
Piik/docs/guide/troubleshooting.md
T
AAAandPedro Antonio c18502fd18 feat: improve microphone, chat and platform support
This release adds microphone processing controls and local chat controls, expands platform packages, and synchronizes the website and guides. It also fixes native H.264 input/format handling, signaling recovery, fresh STUN discovery, and UDP ownership during overlapping connections.

This is **v1.8.0**. Browser/Server v23, Native control v9 and capture v7 remain unchanged, with the existing 1440p ceiling. Additional resolutions, capability negotiation and Magicsock are separate follow-up work.

## Validation

- Full local Web check: 79 files / 1,317 tests, TypeScript and production build.
- Full Go checks, platform builds and Windows native capture regressions/probe.
- Native H.264 Host lifecycle, Browser-to-App fanout and App-exit recovery, and Native H.264 through embedded SFU: all passed with owned process/port/profile cleanup.
- Website build, documentation and repository hygiene passed. Existing UI acceptance covers narrow screens, both languages/themes, architecture downloads and all 23 film checks; final packaging and Go race checks run on the merged revision in CI.
- Physical macOS/Linux capture, representative public networks and unmatched field reports retain their documented evidence limits. No claim that every blur/disconnection report is resolved.

## Release notes

### 中文

这是一次功能与兼容性更新:麦克风和聊天增加了实用的小选项,App 与 Server 支持更多设备,同时修复了原生分享和连接恢复中的若干问题。现有 1.x 协议保持不变。

#### 新增与改进

- 浏览器麦克风新增「降噪与回声消除」开关,默认开启回声消除、降噪和自动增益;分享音乐或使用虚拟音频输入时,可按需关闭。
- 可调整弹幕字号和透明度,并将当前保留的聊天记录导出为 TXT。当前会话最多保留 1,000 条文字消息,刷新页面后清空;需要保存时请先导出。
- 新增 Intel Mac、Linux ARM64 App,以及 Linux ARM64 Server 和容器镜像。官网下载区可直接选择对应架构,并显示最新版本和发布时间。
- 更新官网演示、README 截图和中英文教程,明确浏览器分享也可选择窗口或屏幕;开始分享前显示房间号占位,保持底栏控件位置稳定。
- 官网新增直达问题排查的入口,补充浏览器 WebRTC 限制、校园网和 Windows 显卡相关的排查步骤。
- App 模式选择页显示免费开源说明、作者与贡献者署名,以及官方网站和源码链接。

#### 修复

- 修正部分 H.264 原生分享的格式兼容性校验,以及 Windows 编码器输入长度和输出缓冲区对齐问题。
- 清理已失效的重连任务和 Native 接收信令,避免旧连接继续影响当前会话。
- 修复 App 重连时可能复用过期公网地址的问题;重新探测使用当前地址,并处理探测丢包和过期响应,保留其他正常连接。
- 修复 App 新旧媒体连接重叠时共用端口造成的冲突,避免准备或撤销新连接打断仍在使用的画面;关闭连接时及时取消未完成的端口映射请求。
- 无站点密码时,连接恢复不再误引导用户输入站点密码。
- 房间失效或会话终止时,开播前后的原因提示统一显示在电视状态图标中,避免额外提示条。
- 修正 Linux 原生采集的时间戳与关键帧时间基准。感谢 Pedro Antonio 在 [#449](https://github.com/TNTcraftHIM/Piik/pull/449) 的贡献。

#### 使用说明

下载对应平台的完整压缩包,退出旧 App 后解压使用。Windows 继续提供 x64;macOS 提供 Apple 芯片与 Intel 版本,原生采集需要 macOS 13 或更新版本。Linux 提供 x64 与 ARM64,原生采集还需安装[系统组件](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md)。macOS 和 Linux 的实机覆盖仍有限,欢迎反馈。

### English

This update adds useful microphone and chat controls, brings Piik to more devices, and fixes several native-sharing and connection-recovery issues. The existing 1.x protocols remain unchanged.

#### New and improved

- Browser microphones now have a “Noise & echo reduction” toggle. Echo cancellation, noise suppression and automatic gain control are on by default; turn them off when appropriate for music or virtual audio inputs.
- Adjust chat-overlay text size and opacity, and export retained messages as TXT. The current session keeps up to 1,000 text messages and clears on page refresh; export first if you want to keep them.
- Added Intel Mac and Linux ARM64 App packages, plus Linux ARM64 Server and container images. The website provides architecture selectors and shows the latest release and publication date.
- Updated the website demonstration, README screenshots and bilingual guides, clarifying that browser capture can also select windows or screens. A room-code placeholder keeps the bottom bar stable before sharing starts.
- Added direct website links to troubleshooting, with steps for browser WebRTC restrictions, campus networks and Windows graphics issues.
- The App mode-selection page now shows its free and open-source status, author and contributor credit, and links to the official website and source.

#### Fixes

- Corrected H.264 format compatibility checks and Windows encoder input-length and output-buffer alignment handling.
- Retired stale reconnect tasks and Native receive signals so they cannot continue affecting the current session.
- Fixed App reconnection reusing an expired public address. Fresh discovery handles lost probes and stale responses while preserving other working connections.
- Fixed UDP socket conflicts between overlapping App media connections so preparing or canceling a replacement preserves the active picture. Closing a connection now cancels unfinished gateway mapping requests.
- Connection recovery on passwordless sites no longer incorrectly asks for a site passphrase.
- Expired-room and session-termination reasons now use the same TV status indicator before and during sharing, without an extra notice strip.
- Corrected Linux native capture timestamps and keyframe time bases. Thanks to Pedro Antonio for [#449](https://github.com/TNTcraftHIM/Piik/pull/449).

#### Updating

Download the complete archive for your platform, quit the old App, and extract the new package. Windows remains x64-only. macOS packages support Apple silicon and Intel; native capture requires macOS 13 or newer. Linux supports x64 and ARM64 and requires additional [system components](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md) for native capture. Physical-device coverage on macOS and Linux remains limited; feedback is welcome.

## Attribution

Co-authored-by: Pedro Antonio <wrenchwastaken@gmail.com>
2026-10-04 16:21:01 +08:00

16 KiB

Troubleshooting

English · 简体中文 · Documentation

Find the symptom below and try the suggested checks. Stop when it works; collect a diagnostic report if the problem persists.

Common problems

What you see Try this
Picture but no source sound Unmute the video. The host should choose a source with shareable audio and enable sound in the source picker.
Cannot hear the host's voice The host can enable Microphone below the picture, then check the selected input and its volume in Sharing settings → Sound. Check the device connection and microphone permission. If the control is unavailable, update the App and refresh the page.
No screen picker Allow the browser or App to record the screen when the OS asks. Browser capture needs HTTPS or localhost; try sharing from a desktop computer.
No App windows or screens listed Check the message in the source picker, then follow App source troubleshooting. Browser → Choose what to share opens the browser's screen, window or tab chooser.
H264 fails to start, or sharing stops just after source selection Try Auto or VP8, then follow Windows H264 and graphics checks.
Yellow outline around the shared window or screen This is Windows' capture indicator. See capture borders for Windows 11 controls and an optional Windows 10 workaround.
App startup fails Read the reason on the page and in the terminal. Reopen the App and enable the chip-shaped Debug launch control after the theme button before trying again. A failed startup then exports a report; its path appears in the terminal.
Local invitation will not open Check that both devices are on the same network and can reach each other. Guest Wi-Fi or firewall rules can block local access.
Cannot create a room (403) On a self-hosted site, ask the administrator to check the allowed site address.
Page opens but video will not connect Use Reconnect if available, or refresh the viewing page. See connection troubleshooting if it still fails.
WebRTC or IP-leak protection is enabled Check whether it blocks media connections using browser WebRTC settings.
Connection fails on a campus or restricted network Compare with a phone hotspot, then consider a site with SFU forwarding.
Sharing stops after sleep or suspension Wake the device and return to the sharing tab; start sharing again if needed. Browser and OS suspension can interrupt capture or playback.

For a bug report, include the version, OS/browser, what you expected, and how to reproduce it. Diagnostics and export explains how to collect a local report and what to review before sharing it.

Room creation returns 403

Piik rejects room creation from a browser address that the server has not allowed, even when the page opens normally. The site administrator should:

  1. Set PUBLIC_BASE_URL to the browser's site address, including the scheme and any non-default port, without a path.
  2. Unset or empty ALLOWED_ORIGINS to use that address. If several addresses are needed, list every trusted origin explicitly, separated by commas. Check for an old http://localhost:8787 override after copying a configuration example.
  3. Restart Piik (recreate the container with docker compose up -d for Compose), reload the page and retry.

If the response says Origin not allowed with correct settings, check that the reverse proxy preserves the browser's Origin header. A 403 from the proxy or WAF itself needs its own logs; do not disable origin validation to bypass it. See Server deployment for the configuration.

App windows or screens are missing

Keep Piik App running on the computer where you are sharing. Open the current site from the App; for a hosted site, use the App's Site mode with that site's address. If the browser asks for local-network access, allow it, then refresh the source list. If access was previously blocked, review this site's browser permissions first.

The source picker distinguishes these outcomes:

Message Next step
Cannot connect to Piik App Confirm the App is running and opened this site. Close unused Piik tabs using the App, then refresh the list; up to two pages can use the App's native capture or viewing at once.
Piik App and this page are incompatible Update Piik App and reload the page.
Piik App capture is currently unavailable Check the App diagnostics for capture or encoder availability. Review your encoding setting or use browser capture.
Could not read the screen and window list Refresh to retry. If it keeps failing, export both the App and browser Debug reports.
No sources available The list was read successfully, but this tab has no selectable sources. Check the other source tabs.

Local-network permission lets the page contact the App. It is separate from the WebRTC media settings described below. An unreachable App alone does not prove that permission was denied.

H264 sharing fails on Windows

If selecting a window or screen returns you to the start screen, or reports a sharing failure, it may involve capture, encoding or the Browser-to-App media connection. The message alone does not identify a graphics-driver problem.

  1. Compare codecs on the same source. In Sharing settings, change the video codec from H264 to Auto or VP8, then start sharing again. If VP8 works, you can keep using it while checking the H264 path.
  2. Update and restart. Update Piik App and Chrome, and install the appropriate graphics driver from your computer or GPU manufacturer's official support page. On laptops with two GPUs, check both drivers. Restart after installation.
  3. For Chrome, check graphics acceleration and GPU preference. In Chrome's Settings → System, enable graphics acceleration if it was disabled, then restart Chrome (Google's setting instructions). On a multi-GPU Windows PC, open Settings → System → Display → Graphics, select or add Chrome (chrome.exe), and choose Options → High performance → Save. Completely quit and reopen Chrome before retrying. If it does not help, restore Let Windows decide (Microsoft's graphics settings).

The Windows preference is a browser-side check, not a guarantee of H264 support. Piik App selects its native encoder separately; changing Chrome's GPU preference does not select the App's capture GPU. If App capture still fails, keep the codec comparison and export the App and browser reports for the same attempt. Include your GPU model, driver version, source type and whether VP8 works. If both codecs fail, also check WebRTC restrictions.

Yellow capture border on Windows

Windows draws this outline to identify the window or display being captured. On supported Windows versions, the App source picker offers Show capture border, off by default. Windows permissions or another active capture can still require the border. Windows 10 does not provide this control for its capture API.

Windows 11: the border is still visible

  1. Select Apps / Windows or Screens in Piik and leave Show capture border off. A Browser-selected source uses the browser's own capture indicator.
  2. Stop other apps or tabs capturing the same window/display, then restart sharing.
  3. If Windows denied borderless capture, review Screenshot borders in Windows privacy settings. Its settings page can also be opened with ms-settings:privacy-graphicscapturewithoutborder from Win+R, when available.

Windows requires consent and can retain the border when another capture requests it (Microsoft's API documentation). If it persists, include the Windows version, selected source type and an App diagnostic report with your feedback.

Optional Windows 10 workaround

DWM Custom Projection Border is a third-party Windhawk mod for x64 Windows that can hide the border while keeping the same capture method. It changes Windows' desktop compositor and affects other apps' capture indicators too. The author shows it working on Windows 10 21H2; this procedure has not been tested with Piik on a Windows 10 device.

  1. Install Windhawk from its official website.
  2. In Windhawk's global Settings → Advanced settings → More advanced settings, append dwm.exe to Process inclusion list and save. Keep existing entries.
  3. Find and install DWM Custom Projection Border. In the mod's settings, turn on Disable border and save.
  4. Stop and restart sharing in Piik, then check whether the border disappears.

To undo this, disable the mod and restart sharing. Remove the dwm.exe entry if you added it only for this mod. If desktop problems appear or a Windows update breaks compatibility, disable the mod first.

See the mod author's instructions and Windhawk's process settings for current setup details.

When video will not connect

No media route available means Piik has not found a working path to deliver the picture to your device. Loading the page and receiving media use different connections, so one can work while the other fails.

NAT (Network Address Translation) lets several devices share an Internet address. Routers and providers differ in how they map addresses and admit incoming traffic; some combinations make direct connections difficult. Firewalls and browser policies can also block media. The message alone does not identify the cause.

Try these in order, stopping when the picture arrives:

  1. Retry the viewing page. Choose Reconnect if it is available. If it is disabled or does not help, refresh the viewing page or reopen the invitation. Let each connection attempt finish. One or two fresh attempts can be worth trying; repeated refreshes cannot remove a network restriction.
  2. Check browser WebRTC settings. Browser settings or VPN/privacy extensions can block media even while the page loads. This affects both sharing and viewing; follow browser WebRTC checks below.
  3. Try another network. For example, test a phone hotspot. If you use a VPN or proxy, check its UDP policy; ask the administrator on a managed network.
  4. Enable usable IPv6. Check that your provider, router and device support it. When both peers have working IPv6, Piik can try that direct path alongside IPv4. It does not bypass firewall rules; keep IPv4 enabled too.
  5. Check your own router, if you manage it. On a trusted home network, supported UPnP, PCP or NAT-PMP settings can let the App's native media path request a port mapping. Browser-only capture does not request these mappings. If a modem and router both perform NAT, follow your model's bridge/AP-mode instructions to remove the extra layer. Carrier-grade NAT is upstream of your router; ask your provider about available public IPv4 or IPv6 service. Back up settings before changing the router's operating mode.
  6. Invite a friend on another network. A Viewer who can receive the picture and has spare forwarding capacity may give Piik another path to you. Piik chooses this automatically; extra people help only when those connections work.
  7. Use a site with media fallback. Its operator must enable SFU forwarding. If the site offers Privacy mode, the Host must turn it off before sharing. Sites configured for Server media already require SFU. The public demo.piik.tv site and the App's Public invite mode do not provide SFU. Self-hosting is an advanced option. Both P2P and SFU media currently use UDP; a network that blocks UDP entirely still needs a different network or an administrator's help.

Router menus vary by model. These manufacturer guides explain IPv6 prerequisites, UPnP, and double NAT with a modem and router. The WebRTC connection guide explains discovery and connection checks in more technical detail.

If these steps do not help, collect a Debug report from the affected Viewer and, if possible, the Host for the same attempt. Include the time, Piik version and network type when reporting the problem.

Browser WebRTC restrictions

WebRTC carries Piik's picture and sound. Disabling it or blocking non-proxied UDP can prevent viewing and even the local Browser-to-App media connection. Successful source selection does not prove that connection works. Hiding local IP addresses alone does not necessarily block WebRTC.

  1. Open the same invitation in a browser profile with default settings and no VPN/privacy extensions. If that works, check the original profile's WebRTC or IP-leak protection settings.
  2. Restore a policy that allows WebRTC UDP. A policy named disable_non_proxied_udp is restrictive; the browser default is a useful comparison. Vivaldi exposes Settings → Privacy and Security → WebRTC IP Handling → Broadcast IP for Best WebRTC Performance. Chrome extensions can control this policy even without a visible browser switch.
  3. Reload the affected Piik page and retry. If a school or company manages the setting, ask its administrator to review it.

Allowing these connections can expose network addresses to WebRTC peers; change only the relevant setting. See Chrome's policy reference and Vivaldi's privacy settings.

Campus networks and strict NAT

A campus network can work with Piik, but a shared Internet gateway or restrictive firewall may make direct connections harder. Try a phone hotspot first: if the same invitation works there, focus on the original network's restrictions.

For regular use, consider self-hosting a Piik site with SFU media forwarding. This gives viewers a server path when direct connections fail. Follow the deployment guide, including its public-address and UDP-port requirements. The Host can then open that site through the App's Site mode and send invitations from the new site.

The public demo and App Public invite mode remain P2P-only. SFU also requires usable UDP: when the network blocks UDP entirely, use another network or ask the administrator for access. Deploying a server alone does not remove that restriction.

Ready to host a site for your group? Follow self-hosting. For other guides, return to the documentation home.