Bilibili 直播 WebSocket/TCP API 使用教程

Bilibili 直播 WebSocket/TCP API 使用教程

bilibili-live-ws Bilibili live WebSocket/tcp API 项目地址: https://gitcode.com/gh_mirrors/bi/bilibili-live-ws

1. 项目介绍

本项目是基于 JavaScript 开发的 Bilibili 直播 WebSocket/TCP API，它允许开发者通过 WebSocket 或 TCP 协议与 Bilibili 直播平台进行交互。项目提供了丰富的 API 接口，支持实时获取直播间信息、弹幕、礼物等数据，并能够发送心跳包以维持连接状态。

2. 项目快速启动

首先，确保你的开发环境已经安装了 Node.js。

安装

通过 npm 安装 bilibili-live-ws：

npm install bilibili-live-ws

WebSocket 连接示例

以下是一个使用 WebSocket 连接到 Bilibili 直播间并监听事件的示例：

const { LiveWS } = require('bilibili-live-ws');

const roomid = 14327465; // 替换为实际的房间号
const live = new LiveWS(roomid);

live.on('open', () => {
  console.log('WebSocket 连接成功');
});

live.on('live', () => {
  console.log('成功进入直播间');
});

live.on('heartbeat', (online) => {
  console.log(`当前人气值：${online}`);
});

live.on('msg', (data) => {
  console.log('收到信息：', data);
});

// 开始连接
live.connect();

TCP 连接示例

以下是一个使用 TCP 连接到 Bilibili 直播间并监听事件的示例：

const { LiveTCP } = require('bilibili-live-ws');

const roomid = 26283; // 替换为实际的房间号
const live = new LiveTCP(roomid);

live.on('open', () => {
  console.log('TCP 连接成功');
});

live.on('live', () => {
  console.log('成功进入直播间');
});

live.on('heartbeat', (online) => {
  console.log(`当前人气值：${online}`);
});

live.on('msg', (data) => {
  console.log('收到信息：', data);
});

// 开始连接
live.connect();

3. 应用案例和最佳实践

实时弹幕展示

你可以使用以下代码来实时展示弹幕：

live.on('DANMU_MSG', (data) => {
  console.log('弹幕：', data.info[1][0]);
});

定时发送心跳包

为了维持连接，你可以定时发送心跳包：

setInterval(() => {
  live.heartbeat();
}, 30000); // 每 30 秒发送一次心跳包

4. 典型生态项目

目前，基于 Bilibili 直播 WebSocket/TCP API 的生态项目较少，但开发者可以在此基础上构建自己的应用，如直播间数据分析、弹幕过滤系统、直播间监控工具等。开发者可以参考本项目提供的 API 文档和示例，快速搭建自己的直播间相关应用。

bilibili-live-ws Bilibili live WebSocket/tcp API 项目地址: https://gitcode.com/gh_mirrors/bi/bilibili-live-ws