WebsitePusher 公开 API 演示
注意:当前 通道码 集成在前端页面,所有人可见,$.getJSON()适用于匿名推送的场景,例如公开留言板。如果只允许注册用户发送弹幕或者需要保存点赞数据,需参考server.html进行过滤。
trigger接口将请求后端向云端写入一条弹幕记录,只有head参数必传,avatar 可不传. 缺省自动生成。
弹幕文字必选,头像链接、跳转链接可为空,其余可选项有默认值(继承自 danMuSetting)。
修改下方参数后点「应用」,updateDanMu 会深合并到 danMuSetting 并立即对后续弹幕生效。
弹幕运行期间可动态控制可见性、滚动、清屏与生命周期。
hideDanMu 用 visibility:hidden,动画继续不丢消息。
pauseDanMu 冻结滚动,新消息暂存队列;resumeDanMu 重启滚动并刷新暂存队列。
clearDanMu 只清当前弹幕不影响连接;stopDanMu 断开 Socket.IO+停 AI 轮询+清屏;startDanMu 重连+重启轮询。
在你的网站任意页面引入下面这一行 <script>,danmu.js 会自动加载依赖并调用 WebsitePusher.init()弹幕插件:
| 属性 | 说明 |
|---|---|
siteName | 站点名称 |
apiKey | 弹幕云服务API Key, 固定值, 不可修改 |
cssSite | CSS 资源根路径, 可定制为业务方cdn地址 |
jsSite | JS 资源根路径, 可定制为业务方cdn地址 |
pcUrl | PC 端页面地址, 可定制为业务方cdn地址和样式 |
pushUrl | 弹幕云服务官网, 固定值, 不可修改 |
apiUrl | 弹幕云服务API接口, 固定值, 不可修改 |
authUrl | 弹幕云服务Oauth接口, 固定值, 不可修改 |
wsUrl | 弹幕云服务Socket接口, 固定值, 不可修改 |
channelMemberUrl | 弹幕云服务API接口, 固定值, 不可修改 |
appName | 自定义应用名称(用于数据统计) |
channelCode | 指定通道码, 可到弹幕云服务官网注册后获取后传参, 认证域名后自动创建弹幕通道码可不传 |
uid | 弹幕云成员ID, 长整形数字, 仅用于标识 |
name | 弹幕云成员昵称 |
createTime | 弹幕云成员加入时间 |
token | 弹幕云成员弹幕服务令牌 |
avatar | 弹幕云成员加入时分配的头像, 默认为浏览器头像 |
device | 访问成员设备码, 不同浏览器、不同版本设备码不同 |
clientVersion | 访问成员客户端版本 |
screenResolution | 访问成员屏幕分辨率 |
userPlatformType | 访问成员用户平台类型 |
userPlatformVersion | 访问成员用户平台版本 |
hideDialog | 是否隐藏对话框(0=显示, 1=隐藏), 支持danmu.js?hideDialog=1关闭对话框模式 |
hidePanel | 是否隐藏推送面板(0=显示, 1=隐藏), 支持danmu.js?hidePanel=1关闭弹幕配置面板 |
danMu | 是否开启弹幕(0=关闭, 1=开启), 支持danmu.js?danMu=1开启弹幕 |
closeText | 自定义关闭/举报按钮文字, 仅当danMuSetting.close=1时生效 |
danMuSetting | 弹幕外观配置(嵌套对象, 子属性见下方) |
danMuSetting.opacity | 背景不透明度(0~100, 100=不透明) |
danMuSetting.size | 弹幕字号(8~33) |
danMuSetting.speed | 滚动速度(秒) |
danMuSetting.close | 是否显示关闭按钮(0=否, 1=是, 优先于 like) |
danMuSetting.like | 是否显示点赞按钮(0=否, 1=是), 仅当danMuSetting.close=0时生效 |
danMuSetting.bottom | 距屏幕底部距离(px, bottomradio=1 时生效) |
danMuSetting.bottomradio | 是否按 bottom 定位(0=随机位置, 1=固定) |
danMuSetting.aiDanMu | AI 弹幕轮询间隔(秒, 0=关闭), 支持danmu.js?aiDanMu=30开启AI弹幕每30秒轮询 |
danMuSetting.aiDanMuUrl | AI 弹幕自定义接口地址 |
danMuSetting.selector | 弹幕挂载 DOM 选择器(默认 body) |
danMuSetting.color | 弹幕文字颜色 |
danMuSetting.hideIcon | 是否隐藏右下角浮窗图标(0=显示, 1=隐藏), 支持danmu.js?hideIcon=1关闭弹幕右下角图标 |
messageLength | messageIdList 容量上限, 如果访问成员大于20000人可尝试着增加此值 |
| 方法 | 说明 |
|---|---|
init(options) | 接入入口,options 为 settings 覆盖项,嵌套对象(如 danMuSetting)按字段深合并 |
hideDanMu() | 隐藏弹幕(visibility:hidden, 动画继续不丢消息) |
showDanMu() | 显示弹幕(移除 hideDanMu 的隐藏样式) |
pauseDanMu() | 暂停弹幕(冻结滚动, 新消息暂存队列) |
resumeDanMu() | 恢复弹幕(重启滚动, 刷新暂存队列) |
clearDanMu() | 清屏(移除所有弹幕元素+清空暂停队列, 不影响连接) |
updateDanMu(options) | 更新弹幕配置并立即生效(外观/AI轮询), options 为 danMuSetting 字段子集 |
setDanMuArea(ratio) | 设置显示区域比例(0.1~1, 如 0.5=上半屏) |
stopDanMu() | 停止弹幕:断开 Socket.IO、停 AI 轮询、清屏,保留 token/doc 供恢复 |
startDanMu() | 启动弹幕:重连 Socket.IO、重启 AI 轮询(依赖 stopDanMu 前保存的上下文) |
danMuSendOpen(settings) | 右下角danMuIcon回调钩子:右下角弹幕图标首次点击时触发(开启弹幕发送),需在 init 时传入 |
danMuSendClose(settings) | 右下角danMuIcon回调钩子:右下角弹幕图标再次点击时触发(关闭弹幕发送),需在 init 时传入 |
sendDanMu(item) | 主动发送弹幕(仅调试样式使用, 当前屏幕滚动, 不请求业务方后端),如需存储后再推送, 请在sendCallback回调中异步请求业务方后端, 人工审核通过再由后端进行推送 |
destroy() | 销毁所有资源(DOM/事件/Socket.IO/定时器/缓存), 销毁后可重新调用 init() 初始化 |