DevSource - OsuSync/Sync GitHub Wiki

弹幕源同步组件

弹幕源是指，继承了SourceBase类，并实现其抽像接口的，具有从某个网站获取实时的弹幕或评论，并将其在合适的时机通过消息管理器发送给游戏同步组件的类。

SourceBase类成员列表

类别	成员名称	类型	说明
Property Get	Name	String	获得源名称
Property Get	Author	String	获得源作者
Property Get/Set	LiveID	String	由程序管理的直播ID标识号
Property Get	EventBus	BaseEventDispatcher<ISourceEvent>	获得由程序管理的全局源事件触发和绑定器
Property Get/Protected Set	Status	SourceStatus	获得或设置当前弹幕源的工作状态

SourceBase类函数列表

标识	函数签名	返回类型	说明
Public	SourceBase(string Name, string Author)	.ctor	初始化源的必备构造函数
Protected	RaiseEvent<T>(T args)	void	只供源本身使用的事件触发函数
Public abstract	Connect()	void	当源连接时，由程序调用的函数
Public abstract	Disconnect()	void	当用户有需要断开时，由程序调用的函数

Source Base类是最基础的直播弹幕源实现，在实现中只有接收弹幕的功能，并不具备让程序识别，并将游戏中的弹幕发送到直播源中的功能。

如果想实现具有发送功能的弹幕源（即可在游戏中通过Client向直播源发送弹幕/评论等讯息），你可以选择不继承SourceBase类，改为继承SendableSource类，这样，主程序就能识别这是一个“可以发送弹幕”的弹幕源了~

SendableSource是SourceBase的继承实现，拥有SourceBase的全部功能

类别	成员名称	类型	说明
Property Get/Private Set	SendStatus	Bool	获得当前源是否能发送的状态信息

标识	函数签名	返回类型	说明
Public abstract	Login(string user, string password)	void	用户在程序中做出让直播源登录的操作所调用的函数
Public abstract	Send(IMessageBase message)	void	用户或Client需要弹幕源向目标网站发送弹幕的请求时所调用的函数