Flutter流媒体客户端插件xtream_code_client的使用

描述

xtream_code_client 是一个 Dart 包，提供了与 Xtream Codes API 交互的客户端。Xtream Codes 是一个 IPTV 面板，允许服务提供商管理自己的 IPTV 服务及其客户。它提供了一个简单而强大的 API 来管理用户、订阅和计费。

该包为 Xtream Codes API 提供了便捷且高效的访问方式，具有自动重试和错误处理等功能。它包括各种模型来表示不同的数据结构，如类别、频道 EPG（电子节目指南）、一般信息、直播流项目、系列信息等。

此包设计用于 Flutter SDK，并根据使用的平台智能选择最合适的 HTTP 客户端实现，确保最佳的功能性和性能。

什么是 Xtream Codes？

Xtream Codes 是由服务提供商用来管理其 IPTV 服务的 IPTV 面板。它为管理用户、订阅和计费提供了全面的 API。通过 Xtream Codes，提供商可以创建、管理和分发他们的 IPTV 频道和 VOD 内容。

安装 💻

注意：为了开始使用 Xtream Code Client，您必须在机器上安装 Flutter SDK。

通过 flutter pub add 安装：

dart pub add xtream_code_client

使用

首先实例化 XtreamCodeClient：

import 'package:xtream_code_client/xtream_code_client.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await XtreamCode.initialize(
    baseUrl: 'https://your-xtream-codes-api-url',
    username: 'your-username',
    password: 'your-password',
  );

  runApp(MyApp());
}

// 将 XtreamCode http 客户端提取到变量中以便后续使用
final client = XtreamCode.instance.client;

现在您可以使用客户端与 Xtream Codes API 进行交互。

功能示例

// 实例化 XtreamCodeClient
var client = XtreamCodeClient(baseUrl, streamUrl, http);

// 调用 serverInformation
var serverInfo = await client.serverInformation();

// 调用 liveStreamCategories
var liveStreamCategories = await client.liveStreamCategories();

// 调用 vodCategories
var vodCategories = await client.vodCategories();

// 调用 seriesCategories
var seriesCategories = await client.seriesCategories();

// 调用 livestreamItems 并传递类别
var liveStreamItems = await client.livestreamItems(category: liveStreamCategories.first);

// 调用 vodItems 并传递类别
var vodItems = await client.vodItems(category: vodCategories.first);

// 调用 vodInfo 并传递 VOD 项
var vodInfo = await client.vodInfo(vodItems.first);

// 调用 seriesItems 并传递类别
var seriesItems = await client.seriesItems(category: seriesCategories.first);

// 调用 seriesInfo 并传递系列项
var seriesInfo = await client.seriesInfo(seriesItems.first);

// 加载完整的 EPG 表格，格式为 XMLTV。
// 这比仅加载单个频道的其他两个选项要快得多
var epgTable = await client.epg();

// 调用 channelEpg 并传递直播流项和限制
var channelEpg = await client.channelEpg(liveStreamItems.first, 10);

// 调用 channelEpgTable 并传递直播流项
var channelEpgTable = await client.channelEpgTable(liveStreamItems.first);

示例 Demo

以下是一个完整的 Flutter 应用示例，展示如何使用 xtream_code_client 插件：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await XtreamCode.initialize(
    baseUrl: 'https://your-xtream-codes-api-url',
    username: 'your-username',
    password: 'your-password',
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  final client = XtreamCode.instance.client;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  Future<void> _fetchLiveStreams() async {
    var liveStreamCategories = await client.liveStreamCategories();
    var liveStreamItems = await client.livestreamItems(category: liveStreamCategories.first);
    print('Fetched ${liveStreamItems.length} live stream items');
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            ElevatedButton(
              onPressed: _fetchLiveStreams,
              child: const Text('Fetch Live Streams'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

法律声明

本软件按“原样”提供，不提供任何形式的明示或暗示担保，包括但不限于适销性、特定用途适用性和非侵权的担保。在任何情况下，作者或版权持有人均不对因使用本软件或通过本软件获取的数据引起的任何索赔、损害或其他责任负责。

请注意，本包仅供合法使用。用户有责任确保他们拥有使用 Xtream Codes API 及其访问的任何数据所需的必要权利和权限。本包的作者对任何非法使用不承担责任。