Flutter Twitch聊天集成插件twitch_chat的使用

Flutter Twitch聊天集成插件twitch_chat的使用

twitch_chat

此包用于通过Websocket和IRC连接并使用Twitch聊天。

特性

• ✅ 连接到聊天
• ✅ 匿名连接
• ✅ 获取徽章
• ✅ 获取表情符号
• ✅ 获取BTTV、FFZ与7TV的表情符号
• ✅ 禁言、暂停、删除消息

开始使用

获取访问令牌

在使用该插件之前，你需要获取一个访问令牌。你可以通过Twitch的开发者控制台生成此令牌，并确保使用以下范围：

• chat:read
• chat:edit

使用方法

初始化聊天

TwitchChat twitchChat = TwitchChat(
  'your_channel_name', // 需要加入的频道名称
  'your_username', // 你的用户名
  'your_access_token', // 你的访问令牌
  clientId: 'your_client_id', // 客户端ID
  onConnected: () {}, // 连接成功回调
  onClearChat: () {}, // 清空聊天回调
  onDeletedMessageByUserId: (String? userId) {}, // 通过用户ID删除消息回调
  onDeletedMessageByMessageId: (String? messageId) {}, // 通过消息ID删除消息回调
  onDone: () {}, // 完成回调
  onError: () {}, // 错误回调
  params: TwitchChatParameters(addFirstMessages: true), // 参数设置
);

连接到聊天

twitchChat.connect();

监听新聊天消息

twitchChat.chatStream.listen((message) {
  print('New message: $message');
});

监听连接状态更新

twitchChat!.isConnected.addListener(() {
  if (twitchChat.isConnected.value) {
    print('Connected to chat');
  } else {
    print('Disconnected from chat');
  }
});

发送消息

twitchChat.sendMessage('Hello, Twitch!');

访问表情符号和徽章

// Twitch表情符号
twitchChat.emotes;
twitchChat.emotesFromSets; // 包含所有订阅表情符号
twitchChat.cheerEmotes;

// BTTV, 7TV, FFZ表情符号（频道和全局）
twitchChat.thirdPartEmotes;

// 全局及频道徽章
twitchChat.badges;

显著的应用程序

• irl-link 用于IRL主播

示例代码

以下是完整的示例代码：

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Twitch Chat Example')),
        body: Center(
          child: Text('Check console for chat messages'),
        ),
      ),
    );
  }
}

class ChatExample extends StatefulWidget {
  [@override](/user/override)
  _ChatExampleState createState() => _ChatExampleState();
}

class _ChatExampleState extends State<ChatExample> {
  late TwitchChat twitchChat;

  [@override](/user/override)
  void initState() {
    super.initState();

    twitchChat = TwitchChat(
      'your_channel_name',
      'your_username',
      'your_access_token',
      clientId: 'your_client_id',
      onConnected: () {
        print('Connected to chat');
      },
      onClearChat: () {
        print('Chat cleared');
      },
      onDeletedMessageByUserId: (String? userId) {
        print('Message deleted by user ID: $userId');
      },
      onDeletedMessageByMessageId: (String? messageId) {
        print('Message deleted by message ID: $messageId');
      },
      onDone: () {
        print('Connection done');
      },
      onError: () {
        print('Error occurred');
      },
      params: TwitchChatParameters(addFirstMessages: true),
    );

    twitchChat.connect();
    twitchChat.chatStream.listen((message) {
      print('New message: $message');
    });

    twitchChat!.isConnected.addListener(() {
      if (twitchChat.isConnected.value) {
        print('Connected to chat');
      } else {
        print('Disconnected from chat');
      }
    });
  }

  [@override](/user/override)
  void dispose() {
    twitchChat.disconnect();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container();
  }
}