B站直播间弹幕野生接口。
//创建一个BLiveApi对象
var api = new BLiveApi();
//用于接收认证消息的方法(没啥用,可以不写)
private void OpAuthReplyEvent(object sender, (JObject authReply, byte[] rawData) e)
{
}
//用于接收心跳消息的方法
private void OpHeartbeatReplyEvent(object sender, (int heartbeatReply, byte[] rawData) e)
{
}
//用于接收主动关闭消息的方法(使用者主动调用api.Close()时),同时会触发异常
private void WebSocketCloseEvent(object sender, (string message, int code) e)
{
}
//用于接收被动关闭消息的方法(一般是网络错误等原因),同时会触发异常
private void WebSocketErrorEvent(object sender, (string message, int code) e)
{
}
//用于接收API内部解码错误,一般情况下不会触发,除非B站改逻辑或其他特殊情况,此消息触发时不会引起异常
//目前发现在不同的C#版本引入库时会出现不同的问题，所以暂时将此异常抛出并终止与直播间的连接
//Unity使用本库时Brotli库不可用,在使用API的Connect方法时请将第二个参数设置为2
//.NET项目使用本库时需要自己在NuGet安装 Newtonsoft.Json
//.NET Framework项目目前使用无问题
private void DecodeErrorEvent(object sender, (string message, Exception e) e)
{
}
//用于接收API内部提供的一个简单处理过后的弹幕消息的方法
//此方法订阅DanmuMsg事件时会和使用者创建并绑定了携带[TargetCmd("DANMU_MSG")]的方法一样屏蔽掉携带OTHERS的方法(可看下面的示例)
private void DanmuMsgEvent(object sender, (string msg, ulong userId, string userName, int guardLevel,string face, JObject jsonRawData, byte[] rawData) e)
{
}
//当方法与OpSendSmsReply绑定时需要使用[TargetCmd("cmd1","cmd2"...)]设置方法想要接收的命令,建议每个方法只设置1个命令
//此方法是使用者自定义的用于接收OpSendSmsReply事件中SEND_GIFT命令对应的事件的方法
[TargetCmd("SEND_GIFT")]
private void OnSendGiftEvent(object sender, (string cmd, string hitCmd, JObject jsonRawData, byte[] rawData) e)
{
}
//TargetCmd支持填入ALL和OTHERS
//当携带ALL或者没有标注[TargetCmd("cmd1","cmd2"...)]时,该方法会无差别的接收所有SMS消息,但会首先命中TargetCmd参数列表中的其他命令
//当cmd只命中ALL或此方法未携带[TargetCmd("cmd1","cmd2"...)]时,不视作命令被命中,携带OTHERS的方法仍然会被Invoke
[TargetCmd("ALL")]
private void OnAllEvent(object sender, (string cmd, string hitCmd, JObject jsonRawData, byte[] rawData) e)
{
}
//当携带OTHERS时,该方法会接收未被其他方法命中的SMS消息,但TargetCmd参数列表中的其他命令被命中时不会被再次Invoke
[TargetCmd("OTHERS")]
private void OtherMessagesEvent(object sender, (string cmd, string hitCmd, JObject jsonRawData, byte[] rawData) e)
{
}
//绑定事件
api.OpAuthReply += OpAuthReplyEvent;
api.OpHeartbeatReply += OpHeartbeatReplyEvent;
api.WebSocketClose += WebSocketCloseEvent;
api.WebSocketError += WebSocketErrorEvent;
api.DecodeError += DecodeErrorEvent;
api.DanmuMsg += DanmuMsgEvent;
api.OpSendSmsReply += OnSendGiftEvent;
api.OpSendSmsReply += OnAllEvent;
api.OpSendSmsReply += OtherMessagesEvent;
//连接到某个直播间,Connect内有可能会抛出一些回事WebSocket断开连接的异常,需要监听并处理
try
{
//Connect的第一个参数代表房间号，支持短位房间号
//第二个参数代表数据压缩协议的版本，只支持输入2或3,2代表zlib方式，3代表brotli方式
//因为使用的Brotli库会在unity中报错的原因,建议在unity中使用时填入2
//sessdata为使用者B站Cookie中的SESSDATA,如果不传则以游客身份连接弹幕服务器,如果传入无效的SESSDATA,则会抛出SessdataExpireException
await api.Connect(1234,3,sessdata);
}
catch (Exception e)
{
Console.WriteLine(e);
}
//可以通过Close方法主动关闭WebSocket连接
await api.Close();
//可能出现的异常
ConnectAlreadyRunningException//Connect后没有主动或被动结束,一个api对象同时只能连接到一个房间
InvalidRoomIdException//输入的roomId有误,大概率是B站没有这个房间号对应的直播间
UnknownServerOperationException//未知的消息类型,正常情况下不会出现,可在DecodeError事件中接收到
UnknownVersionException//未知的压缩类型,正常情况下不会出现,可在DecodeError事件中接收到
NetworkException//网络错误,一般会在连接房间但本机无网络的情况下出现
InvalidBytesLengthException//API内部解码过程中出现的问题,正常情况下不会出现,可在DecodeError事件中接收到
WebSocketCloseException//使用者主动关闭了该房间的连接
WebSocketErrorException//被动关闭了该房间的连接,一般出现在正常连接后突然断网一段时间的情况下
InvalidProtoVerException//输入的protoVer有误,只能是2或3
DomainNameEncodingException//主机用户名编码异常,请检查主机用户名中是否有非ASCII字符
SessdataExpireException//SESSDATA过期