插件开发的时候,如果选中插件类型是弹幕类,礼物类,欢迎类或者关注类,会自动加载libzb, 然后JS里面就可以调用libzb的接口. 本文列出了所有的接口.

弹幕类接口

这类接口是和直播房间绑定的,也就是用来接收直播房间数据的接口.

zbmate.connect

描述: 连接直播房间(无需正在直播的房间).
用法:

zbmate.connect()

无需参数,他会自动连接对应的房间.这个时候我们需要监听连接成功的事件.

Sample code:

PubSub.subscribe("connect", function( msg, data ){
console.log( "connect" );
if(vol>0) //这里vol是一个用户配置项,play_audio是播放声音的接口
zbmate.play_audio("智播为您服务","msgaudio",spd,per,vol);
});

zbmate.disconnect

描述: 断开连接(无需正在直播的房间).
用法:

zbmate.disconnect()

无需参数,他会自动连接对应的房间.这个时候我们需要监听连接成功的事件.

Sample code:

PubSub.subscribe("disconnect", function( msg, data ){
console.log( "disconnect" );
});

zbmate.is_connected

描述: 判断房间是否连接
用法:

zbmate.is_connected()

PubSub.subscribe

描述: 注册事件,这里的事件包括

  1. connect: 连接服务器成功
  2. disconnect: 服务器断开服务器
  3. chatmsg: 聊天数据事件,数据格式参考:chatmsg
  4. dgb: 礼物数据事件,数据格式参考:gift
  5. uenter: 欢迎数据事件,数据格式参考:welcome
  6. follow: 关注数据事件. 这部分平台还在开发当中, 现在还没有实现.

Sample code:

PubSub.subscribe("connect", function( msg, data ){
console.log( "connect" );
if(vol>0) //vol spd per vol 都是用户配置项
zbmate.play_audio("智播为您服务","msgaudio",spd,per,vol);
});
PubSub.subscribe("disconnect", function( msg, data ){
console.log( "disconnect" );
});
PubSub.subscribe("chatmsg", function( msg, data ){
console.log( data );
});
PubSub.subscribe("uenter", function( msg, data ){
console.log(data.);
});
PubSub.subscribe("dgb", function( msg, data ){
console.log( data );
});
zbmate.connect();

工具类函数

zbmate.get_random_color

描述: 得到一个随机颜色
Sample code:

var color = zbmate.get_random_color()

zbmate.play_audio

描述: 语音播放一段文本
原型:

zbmate.play_audio = function(text,id="msgaudio",spd,per,volume)

参数说明:

  1. text: 字符串类型.需要播放的文本
  2. id: 字符串类型.目前强制是msgaudio
  3. spd: int类型.语音的速度,范围是1-9,1最慢,5是中等语速,9最快.
  4. per: int类型.语音风格,0:普通女声,1:普通男声,3:度逍遥,4:度丫丫.
  5. vol: int类型.音量,范围0-100.
    Sample code:
    zbmate.play_audio("智播为您服务","msgaudio",spd,per,vol);