跨平台同步播放器指南

https://forward-2.gitbook.io/forward/
Admin
This guide provides comprehensive instructions for installing, configuring, and using a...
Tokens:7,046
Snippets:106
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example: Import Widget Module from URL

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example demonstrating how to import a widget module by specifying its URL.

```text
forward://widget?url=https://example.com/widgets.json
```

--------------------------------

### Example: Test Playback with M3U8 URL

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example of testing playback with a provided M3U8 stream URL.

```text
forward://play?url=https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8
```

--------------------------------

### Emby Multi-line Server Import Example

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example of importing Emby server configurations with multiple lines or endpoints. This allows for failover or different connection options.

```text
forward://import?type=emby&scheme=SCHEME&host=HOST&port=PORT&username=USERNAME&password=PASSWORD&title=abc&line1=http://123.com&line1title=线路1&line2=https://456.com:8898&line2title=线路2
```

--------------------------------

### Example: Global Search for 'Interstellar'

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example of performing a global search for the keyword 'Interstellar' within Forward.

```text
forward://search?q=Interstellar
```

--------------------------------

### Example: IMDb Jump

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example of using the IMDb jump URL scheme to open a specific content's detail page.

```text
forward://imdb?id=tt0133093
```

--------------------------------

### Querying Documentation Dynamically

Source: https://forward-2.gitbook.io/forward/di-shi-zhang-mo-kuai-xi-tong-he-stremio

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://forward-2.gitbook.io/forward/di-shi-zhang-mo-kuai-xi-tong-he-stremio.md?ask=<question>
```

--------------------------------

### Example: TMDB Jump for a Movie

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

An example of using the TMDB jump URL scheme to open a specific movie's detail page.

```text
forward://tmdb?id=603&type=movie
```

--------------------------------

### Import Emby Server Configuration

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Use this URL scheme to quickly add Emby server configurations to Forward. Ensure all parameters are correctly formatted.

```text
forward://import?type=emby&scheme=SCHEME&host=HOST&port=PORT&username=USERNAME&password=PASSWORD
```

--------------------------------

### Import Home Configuration

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

This URL scheme allows importing home screen configurations into Forward. It requires a code and optionally an access password.

```text
forward://home?code=CODE&accessPassword=PASSWORD
```

--------------------------------

### 命令行加密模块文件

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

使用 `curl` 命令通过 POST 请求将本地模块文件发送到指定 URL 进行加密，并将加密后的内容输出到同一路径。

```bash
curl -s -X POST https://widgetencrypt.inchmade.ai --data-binary @<filepath> -o <filepath>
```

--------------------------------

### 配置 .env 文件以使用 TMDB 接口

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

若模块需要调用 TMDB 接口，需在 `.env` 文件中配置 `TMDB_API_KEY` 环境变量。

```env
TMDB_API_KEY=your_tmdb_key_here
```

--------------------------------

### Import Widget Module

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Use this URL scheme to import widget modules into Forward. Provide the URL to the widget configuration file.

```text
forward://widget?url=
```

--------------------------------

### 配置 rstest.config.ts 以启用 .env 文件

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

在 `@rstest/core` 的测试配置中，通过 `pool.execArgv` 选项启用 `.env` 文件加载，以使 TMDB API 密钥在测试环境中可用。

```typescript
import { defineConfig } from "@rstest/core";

export default defineConfig({
  testEnvironment: "node",
  pool: {
    type: "forks",
    execArgv: ["--env-file=.env"],
  },
});
```

--------------------------------

### Import Stremio Source

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

This URL scheme is used to import Stremio sources into Forward. The URL of the source needs to be provided.

```text
forward://stremio?url=
```

--------------------------------

### TypeScript 项目类型定义

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

在 TypeScript 项目中，通过创建 `.d.ts` 文件并引用 `@forward-widget/libs/env` 来获得类型提示和自动补全。

```typescript
/// <reference types="@forward-widget/libs/env" />
```

```typescript
const metadata: WidgetMetadata = {
  name: "My Widget",
  version: "1.0.0",
};
```

--------------------------------

### JavaScript 项目 JSDoc 类型定义

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

对于 JavaScript 项目，可以使用 JSDoc 注释来获取类型提示，通过 `import('@forward-widget/libs/env').WidgetMetadata` 指定类型。

```javascript
/**
 * @type {import('@forward-widget/libs/env').WidgetMetadata}
 */
const WidgetMetadata = {
  name: "My Widget",
  version: "1.0.0",
};
```

--------------------------------

### 使用 WidgetAdaptor 进行单元测试

Source: https://forward-2.gitbook.io/forward/fu-lu-er-forward-widget-kai-fa-zhe-zhi-chi

通过 `WidgetAdaptor` 模拟 Forward Widget 的运行环境，并与 `@rstest/core` 结合使用，可以方便地测试 HTTP 请求等功能。

```typescript
import { expect, test, beforeAll } from "@rstest/core";

beforeAll(async () => {
  const { WidgetAdaptor } = await import("@forward-widget/libs/widget-adaptor");
  rstest.stubGlobal("Widget", WidgetAdaptor);
});

test("测试 HTTP 请求", async () => {
  const response = await Widget.http.get("https://api.example.com/data");
  expect(response.status).toBe(200);
});
```

--------------------------------

### Global Search

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Initiate a global search within Forward using a keyword. This helps in quickly finding content across all integrated sources.

```text
forward://search?q=KEYWORD
```

--------------------------------

### Test Playback

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Use this URL scheme to test playback functionality within Forward. Provide the URL of the media to be tested.

```text
forward://play?url=
```

--------------------------------

### Quanx Filter Rules for Forward Widgets

Source: https://forward-2.gitbook.io/forward/di-shi-zhang-mo-kuai-xi-tong-he-stremio

This is a URL for Quanx that filters Forward widgets. It is recommended to subscribe to this to resolve issues with icon or resource loading.

```URL
https://gist.github.com/MrRegret/5cd24ef8b6e750b975d705bbb1b3d9d9/raw
```

--------------------------------

### Loon Filter Rules for Forward Widgets

Source: https://forward-2.gitbook.io/forward/di-shi-zhang-mo-kuai-xi-tong-he-stremio

This is a URL for Loon that filters Forward widgets. It is recommended to subscribe to this to resolve issues with icon or resource loading. Loon requires subscribing to this plugin and then pointing the plugin proxy to a VPN strategy or node.

```URL
https://gist.github.com/MrRegret/5bb2df7c332157fd35b514af8e635b10/raw
```

--------------------------------

### Surge Filter Rules for Forward Widgets

Source: https://forward-2.gitbook.io/forward/di-shi-zhang-mo-kuai-xi-tong-he-stremio

This is a URL for Surge that filters Forward widgets. It is recommended to subscribe to this to resolve issues with icon or resource loading.

```URL
https://raw.githubusercontent.com/xxxjacc/SurgeRules/main/ForwardWidgetFilter.list
```

--------------------------------

### IMDb Jump

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Quickly open a content's detail page using its IMDb ID.

```text
forward://imdb?id=ID
```

--------------------------------

### TMDB Jump

Source: https://forward-2.gitbook.io/forward/fu-lu-yi-qi-ta-shi-yong-ji-qiao

Jump to a movie or TV show detail page using its TMDB ID. Specify the ID and type (movie or tv).

```text
forward://tmdb?id=ID&type=TYPE
```
Tokens:
Raw