Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/en/guide/web-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The player page path can be customized via the `player-page-path` configuration
- **Time-Shifted Playback**: Supports EPG (Electronic Program Guide) and time-shifted playback (requires catchup source)
- **Fast Startup**: Achieves millisecond-level channel switching with FCC
- **Responsive Design**: UI adapts to both desktop and mobile devices
- **PWA Support**: Can be added to the home screen on phones, tablets, desktops, or LG webOS TVs for app-like quick access
- **Zero Overhead**: Pure web frontend implementation with virtually no resource overhead on rtp2httpd (no decoding/transcoding overhead)

> [!IMPORTANT]
Expand All @@ -42,6 +43,48 @@ The player has built-in MP2 audio software decoding capability:
> [!NOTE]
> Audio software decoding relies on browser Web Workers and WebAssembly for background decoding, which consumes some computational resources and may cause slight heating on mobile devices — this is normal. Additionally, due to browser limitations, background playback on mobile devices is not supported when using software decoding.

## PWA Support and Add to Home Screen

The built-in web player supports PWA (Progressive Web App). You can add the player page to your device's home screen (including phones, tablets, computers, and LG webOS smart TVs) and launch it like a native app for a full-screen, immersive viewing experience.

After adding to the home screen, the desktop icon is named **IPTV** by default and uses the built-in app icon. The player retains local settings such as theme preferences.

### iOS / iPadOS (Safari)

1. Open the player page in Safari (for example, `http://192.168.1.1:5140/player`)
2. Tap **Share** in the extensions menu on the left side of the address bar
3. Scroll down in the share menu and select **Add to Home Screen**
4. Confirm the name and tap **Add**

### Android (Chrome, Edge, etc.)

1. Open the player page in your browser
2. Tap the **Menu** button (⋮) in the top-right corner
3. Select **Add to Home screen** or **Install app**
4. Confirm when prompted

Some browsers also show an install banner in the address bar or at the bottom of the page. Tap **Install** or **Add** to complete the process.

### Desktop (Chrome, Edge)

1. Open the player page in your browser
2. Click the **Install** icon in the address bar (if available), or choose **Cast, save, and share** → **Create shortcut** from the browser menu
3. Confirm when prompted

Once installed, the player runs in a standalone window and can be launched quickly from the system app list, Dock, or taskbar.

### LG TV (webOS)

LG webOS smart TVs can also use the built-in browser to open the player and pin it to the TV home screen:

1. Open the **Web Browser** app on your TV
2. Enter the player page URL in the address bar (for example, `http://192.168.1.1:5140/player`)
3. Open the browser menu and select **Add shortcut to the Home screen**
4. Return to the TV home screen and launch the player from the shortcut

> [!NOTE]
> If you customized the player path via `player-page-path`, use the actual path when adding to the home screen. The shortcut is pinned to the URL used at the time of adding, including query parameters such as `r2h-token` (if present).

## Channel Aggregation

When multiple channels with the **same group and same name** exist in the M3U, the player automatically aggregates them into multiple sources of one channel, displaying them only once in the channel list. Users can switch between different sources (such as different quality levels) using the source selector:
Expand Down
43 changes: 43 additions & 0 deletions docs/guide/web-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ http://192.168.1.1:5140/player
- **时移回看**:支持 EPG 电子节目单和时移回看(需要有回看源)
- **快速起播**:搭配 FCC 可实现毫秒级换台速度
- **响应式设计**:桌面和移动端 UI 自适应
- **PWA 支持**:可添加到手机、平板、桌面或 LG webOS 电视主屏幕,像原生应用一样快捷打开
- **零开销**:纯 Web 前端实现,对 rtp2httpd 运行几乎没有资源占用(无解码转码开销)

> [!IMPORTANT]
Expand All @@ -42,6 +43,48 @@ IPTV 大多数高清、标清频道使用 MPEG-1 Layer 2 (MP2) 音频编码,
> [!NOTE]
> 音频软解依赖于浏览器 Web Worker 和 WebAssembly 在后台解码,会占用一些计算资源,在手机上可能会产生轻微发热,这是正常现象。此外,受限于浏览器,使用软解时在手机上无法保持后台播放。

## PWA 支持与添加到主屏幕

内置 Web 播放器支持 PWA(Progressive Web App)。你可以将播放器页面添加到设备主屏幕(包括手机、平板、电脑,以及 LG webOS 智能电视),像打开原生应用一样一键进入,获得全屏、沉浸式的观看体验。

添加到主屏幕后,桌面图标名称默认为 **IPTV**,并会使用内置的应用图标。播放器会保留主题等本地设置。

### iOS / iPadOS(Safari)

1. 在 Safari 中打开播放器页面(例如 `http://192.168.1.1:5140/player`)
2. 点击地址栏左侧扩展按钮中的 **分享**
3. 在分享菜单中下滑,选择 **添加到主屏幕**
4. 确认名称后点击 **添加**

### Android(Chrome、Edge 等)

1. 在浏览器中打开播放器页面
2. 点击浏览器右上角的 **菜单**(⋮)
3. 选择 **添加到主屏幕** 或 **安装应用**
4. 按提示确认安装

部分浏览器还会在地址栏或页面底部显示安装横幅,点击 **安装** 或 **添加** 即可完成。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document HTTPS before promising install prompts

Separate from the missing-manifest comment, even if a manifest is added, this install-banner flow still won't appear for the documented LAN URLs such as http://192.168.1.1:5140/player: Chromium installability requires HTTPS or localhost (https://web.dev/articles/install-criteria), and this daemon's --listen endpoint is plain HTTP unless users add a TLS reverse proxy. Please call out the HTTPS/reverse-proxy requirement or describe Android/desktop HTTP use as a browser shortcut instead, otherwise users following these steps will not see Install app/the banner.

Useful? React with 👍 / 👎.


### 桌面端(Chrome、Edge)

1. 在浏览器中打开播放器页面
2. 点击地址栏右侧的 **安装** 图标(如有),或从浏览器菜单中选择 **投放、保存和分享** → **创建快捷方式**
3. 按提示确认

安装后,播放器会以独立窗口运行,可从系统应用列表或 Dock / 任务栏快速启动。

### LG 电视(webOS)

LG webOS 智能电视同样支持通过内置浏览器使用播放器,并将页面固定到电视桌面:

1. 在电视上打开 **Web Browser** 应用
2. 在地址栏输入播放器页面地址(例如 `http://192.168.1.1:5140/player`)
3. 打开浏览器菜单,选择 **添加到主屏幕**(Add shortcut to the Home screen)
4. 返回电视主界面,即可从桌面快捷方式启动播放器

> [!NOTE]
> 若通过 `player-page-path` 自定义了播放器路径,请使用实际路径访问后再添加到主屏幕。添加到主屏幕的快捷方式会固定指向添加时的 URL,包括其中的 `r2h-token` 等查询参数(如有)。

## 频道聚合

当 M3U 中存在多个**同组同名**的频道时,播放器会自动将它们聚合为一个频道的多个源,在频道列表中只显示一次。用户可以通过线路选择器切换不同线路(如不同清晰度):
Expand Down
Loading