Flutter管道客户端插件piped_client的使用

Flutter管道客户端插件piped_client的使用

Piped.dart

Piped.dart 是一个简单的 API 客户端，用于访问 piped.video，这是一个 YouTube 的替代前端。它同时支持 Dart 和 Flutter。

安装

对于 Flutter 项目，可以通过以下命令安装 piped_client：

$ flutter pub add piped_client

对于纯 Dart 项目，可以通过以下命令安装 piped_client：

$ dart pub add piped_client

使用

使用导出的 PipedClient 创建一个客户端实例。以下是完整的示例代码，展示了如何使用 piped_client 进行实例列表和搜索操作：

import 'package:piped_client/piped_client.dart';

void main() async {
  // 创建 PipedClient 实例
  final client = PipedClient();

  // 获取实例列表
  final instances = await client.instanceList();

  // 打印所有实例信息
  for (final instance in instances) {
    print('Instance: ${instance.name}${instance.locations} => ${instance.apiUrl}');
  }

  // 搜索 "piped" 相关内容
  final result = await client.search('piped');

  // 遍历搜索结果并打印不同类型的内容
  for (final item in result.items) {
    if (item is PipedSearchItemStream) {
      print('Stream: ${item.title} => ${item.url}');
    } else if (item is PipedSearchItemChannel) {
      print('Channel: ${item.name} => ${item.url}');
    } else if (item is PipedSearchItemPlaylist) {
      print('Playlist: ${item.name} => ${item.url}');
    }
  }
}

支持的API端点

目前实现的API端点包括：

• /search: 搜索视频、频道和播放列表
• /streams: 获取视频流信息
• instance-list: 解析 Instance.md 文件以获取实例列表

许可证

该库采用 MIT 许可证。

完整示例Demo

为了更好地理解 piped_client 的使用，以下是一个完整的 Flutter 示例应用，展示了如何在 Flutter 应用中集成 piped_client 并显示搜索结果。

1. 创建 Flutter 项目

首先，创建一个新的 Flutter 项目：

$ flutter create piped_client_example
$ cd piped_client_example

2. 添加依赖

在 pubspec.yaml 文件中添加 piped_client 依赖：

dependencies:
  flutter:
    sdk: flutter
  piped_client: ^最新版本号

然后运行以下命令以安装依赖：

$ flutter pub get

3. 修改 main.dart

将 lib/main.dart 文件修改为以下内容：

import 'package:flutter/material.dart';
import 'package:piped_client/piped_client.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Piped Client Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: PipedHomePage(),
    );
  }
}

class PipedHomePage extends StatefulWidget {
  @override
  _PipedHomePageState createState() => _PipedHomePageState();
}

class _PipedHomePageState extends State<PipedHomePage> {
  final PipedClient _client = PipedClient();
  List<dynamic> _searchResults = [];
  bool _isLoading = false;

  Future<void> _search(String query) async {
    setState(() {
      _isLoading = true;
      _searchResults.clear();
    });

    try {
      final result = await _client.search(query);
      setState(() {
        _searchResults = result.items;
      });
    } catch (e) {
      print('Error: $e');
    } finally {
      setState(() {
        _isLoading = false;
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Piped Client Example'),
      ),
      body: Column(
        children: [
          Padding(
            padding: const EdgeInsets.all(8.0),
            child: TextField(
              onSubmitted: (query) {
                _search(query);
              },
              decoration: InputDecoration(
                labelText: 'Search',
                suffixIcon: Icon(Icons.search),
              ),
            ),
          ),
          Expanded(
            child: _isLoading
                ? Center(child: CircularProgressIndicator())
                : ListView.builder(
                    itemCount: _searchResults.length,
                    itemBuilder: (context, index) {
                      final item = _searchResults[index];
                      if (item is PipedSearchItemStream) {
                        return ListTile(
                          title: Text(item.title),
                          subtitle: Text('Stream'),
                          trailing: Icon(Icons.play_arrow),
                          onTap: () {
                            // Handle stream tap
                          },
                        );
                      } else if (item is PipedSearchItemChannel) {
                        return ListTile(
                          title: Text(item.name),
                          subtitle: Text('Channel'),
                          trailing: Icon(Icons.person),
                          onTap: () {
                            // Handle channel tap
                          },
                        );
                      } else if (item is PipedSearchItemPlaylist) {
                        return ListTile(
                          title: Text(item.name),
                          subtitle: Text('Playlist'),
                          trailing: Icon(Icons.queue_music),
                          onTap: () {
                            // Handle playlist tap
                          },
                        );
                      } else {
                        return ListTile(
                          title: Text('Unknown item'),
                        );
                      }
                    },
                  ),
          ),
        ],
      ),
    );
  }
}

4. 运行应用

确保你已经连接了设备或启动了模拟器，然后运行以下命令启动应用：

$ flutter run