DimSum Chat

简体中文

English

简体中文

English

主题

主程序 API：常规 ​

访问静态文件 ​

获取 Widgets 目录下的文件。

（默认）非自包含模式下，Widgets 目录位于 %AppData%/MiegoLive/DimSumChat/Widgets/。

自包含模式下，Widgets 目录位于 ./Data/Widgets/。见自包含模式。

（主程序版本 <1.0.0 时，目录为 ./Streamer/ ）

  • 方法 GET

  • API /path/to/file

  • 示例

    例如，要访问静态文件目录下的 example 文件夹中的 index.html 文件，请使用以下 URL：

    默认端口号 13500

    url
    http://localhost:13500/example/index.html

连接 ws 消息 ​

连接主程序的 WebSocket 服务器，获取诸如聊天、礼物等消息。

  • API /websocket

  • 协议 ws

  • 示例

    js
    const webSocket = new WebSocket('ws://localhost:13500/websocket');

    所有 ws 消息均为 json 字符串且具有以下结构：

    json
    {
  "type": ..., // string
  "content": ... // string | object
}

    对于哔哩哔哩 bilibili 与哔哩哔哩开放平台 openblive 消息，type 的内容为对应的 CMD 字段，支持所有消息类型。

    哔哩哔哩开放平台消息请参考哔哩哔哩直播开放文档。

    对于爱稀饭 acfun 消息，支持以下类型：

    CommonActionSignalComment
CommonActionSignalLike
CommonActionSignalUserEnterRoom
CommonActionSignalUserFollowAuthor
CommonActionSignalGift
AcfunStateSignalDisplayInfo
CommonStateSignalDisplayInfo
CommonStateSignalTopUsers
CommonStateSignalRecentComment

    对于抖音 douyin 消息，支持以下类型：

    WebcastChatMessage
WebcastGiftMessage
WebcastLikeMessage
WebcastMemberMessage
WebcastSocialMessage
WebcastRoomUserSeqMessage
WebcastFansclubMessage
WebcastControlMessage

    提示

    你应该使用消息解析器处理大多数情况，对于某些消息解析器未提供的接口，再通过原始消息结构进行数据解析。

加载哔哩哔哩头像 ​

在登录哔哩哔哩账号的前提下，获取用户头像的图像二进制数据。

  • 方法 GET

  • API /bface/{uid} （未来将迁移至 /api/bface/{uid}）

  • 返回类型 对用户头像 URL 的 302 重定向

  • 详细信息

    调用哔哩哔哩接口获取用户 uid 与头像 URL 的对应关系并缓存。

    WARNING

    由于哔哩哔哩接口存在访问频率限制，当 API 访问间隔低于10秒且无缓存时，会返回哔哩哔哩默认头像。未成功的头像缓存任务会加入等待队列中，当 API 超过20秒未被访问时，会执行等待队列中的缓存任务。

  • 示例

    例如，要获取 uid 为 123456 的哔哩哔哩用户的头像图像数据，请使用以下URL：

    url
    http://localhost:13500/api/bface/123456

    在 HTML 中使用：

    html
    <img src="http://localhost:13500/api/bface/123456" alt="" />

<img src="/api/bface/123456" alt="" />

自包含模式 ​

1.0.0 版本前，主程序默认为自包含模式，即所有数据文件存放于主程序所在目录下。

1.0.0 版本起，数据文件将迁移至每用户的程序数据目录下，对于 Windows 系统，该目录应该位于 %AppData%\MiegoLive\DimSumChat。若要开启自包含模式，请在主程序目录下新建一个名称为 _sc_ 或 ._sc_ 的文件，主程序运行后将启用自包含模式，所有数据文件将存放于主程序所在目录的 Data 文件夹中。