b-socket v0.2.0

BSocket - websocket for bilibili open-live

BSocket 是 Bilibili 直播开放平台 WebSocket 长连接封装包，目前可用于 Node 环境（浏览器环境有时间在试试）。

能力有限，有什么错误还请大家指出，谢谢！

Changlog

Install

npm i b-socket --save

Usage

1. 引入包

如果使用 ESM 模块管理，请通过 import 语句引入。

import BSocket from "b-socket"

如果使用 CommonJS 模块管理，请通过 require 语句引入。

const BSocket = require("b-socket")

2. BSocket 类

封装的 BSocket 类是静态类，直接使用。

类的成员:

appKey - 属性 | B站直播开发平台分发给你的 access_key_id

appSecret - 属性 | B站直播开发平台分发给你的 access_key_secret

bodyData - 属性 | 发送 post 请求的数据，一般为房间号 { "room_id": your_room }

api - 属性 | 请求地址，不作修改，默认为 /v1/common/websocketInfo

build() - 方法 | 创建并返回一个 BilibiliWebSocket 实例

例：

BSocket.appKey = "bbtv233"
BSocket.appSecret = "anhao666"
BSocket.bodyData = { "room_id": 9007928 }

// async
const bs = await BSocket.build()

// or promise
BSocket.build()
    .then(r => {
        ...//do something
    })

一步到位!

oneStepOpen(callback) - 方法 | 一步启动，参数：

• callback - 监听消息函数回调，函数参数 data，用于处理监听接收到的弹幕礼物消息。等同于 BilibiliWebSocket 实例的 listenMsgs 方法。

例：

// give a callback, then get the danmu and user
BSocket.oneStepOpen(data => {
    console.log(data.data.uname)    // 漆与丶QoQ
    console.log(data.data.uid)      // 8****8
    console.log(data.data.msg)      // "test"
})

oneStepClose([callback[, ...args]]) - 方法 | 一步关闭，可选参数：

• callback - 关闭连接函数回调，可以断开连接时处理一些事情；
• args - 函数回调的可选参数数组。

例：

// close the connect
BSocket.oneStepClose()

// or give a callback
BSocket.oneStepClose(stringArr => console.log(stringArr[0]), "Closed.")

BilibiliWebSocket 实例

BilibiliWebSocket 实例目前提供了 6 个方法和 1 个属性

websocketInfo - 属性 | post 鉴权请求成功后返回的数据，详见 🔗 获取长连地址和TOKEN

open([host, [port]]) - 方法 | 启动连接。可选参数：

• host - 长连接地址，可以在 websocketInfo 中获取；
• port - 长连接端口，同样在 websocketInfo 中获取。

例：

// use the default
bs.open()

// or use data from websocketInfo
bs.open("broadcastlv.chat.bilibili.com", 2243)

// or promise
BSocket.build()
    .then(r => {
        r.open()
        ...//do something
    })

close() - 方法 | 关闭连接。

getGeneralMsgs() - 方法

• 获取一般 Proto 包消息（非弹幕礼物），如鉴权反馈、心跳反馈，详见 🔗 发送心跳 Operation 字段含义。返回值是一个长度为4的数组。

getReadyState() - 方法

• 获取当前连接状态。0 为 CONNECTING，1 为 OPEN，2 为 CLOSING，3 为 CLOSED, 参考 🔗 MDN 文档 - WebSocket.readyState

getWSURL() - 方法 | 获取当前长连接链接地址.

listenMsgs(callback) - 方法 | 监听消息。参数：

• callback - 回调函数，函数参数 data，用于处理监听接收到的弹幕礼物消息。

例：

// give a callback, then get the danmu and user
bs.listenMsgs(data => {
    console.log(data.data.uname)    // 漆与丶QoQ
    console.log(data.data.uid)      // 8****8
    console.log(data.data.msg)      // "test"
})

// data's structure
data = {
    data: {
        fans_medal_level: 0,
        fans_medal_name: '...',
        fans_medal_wearing_status: false,
        guard_level: 0,
        msg: 'test',
        timestamp: 165****318,
        uid: 8****8,
        uname: '漆与丶QoQ',
        uface: '...',
        msg_id: '...',
        room_id: 9007928
    },
    cmd: 'LIVE_OPEN_PLATFORM_DM' // or other
}

较为完整的使用过程……？

import BSocket from "b-socket"

BSocket.appKey = "bbtv233"
BSocket.appSecret = "anhao666"
BSocket.bodyData = { "room_id": 9007928 }

const bs = await BSocket.build()

bs.open()

const arrMsgs = []

bs.listenMsgs(data => {
    if ("LIVE_OPEN_PLATFORM_DM" == data.cmd) {
        arrMsgs.push({
            uid: data.data.uid,
            uname: data.data.uname,
            uface: data.data.uface
            msg: data.data.msg
        })
    }
})

// do something...

bs.close()

Contribute

目前只实现了一小部分功能，欢迎 Issue 和 Pull Request ~

License

Under the MIT