虎牙 Berry SDK Android 版本接口文档

Transcription

1 虎牙 Berry SDK Android 版本接口文档

2 概述虎牙 Berry SDK 主要提供一套 Android 游戏直播技术方案及接口, 接入方只需调用少数几个接口就可以实现复杂的游戏直播功能, 并拥有很高的可重用性 另外, 虎牙 Berry SDK 提供丰富的互动方式, 如弹幕, 礼物等, 增强主播和粉丝之间的联系和互动 1.1 SDK 接入流程 接入方在虎牙第三方公众平台申请 appid 并获得相应的 appkey 和 gameid 接入虎牙 Berry SDK ( 测试环境和正式环境 ) 接入虎牙第三方统计后台 ( 可选 ) 1.2 支持平台 Android 5.0 及以上 (5.0 以下请屏蔽直播入口 ) 1.3 支持开发环境 Android Studio 1.4 及以上 1.4 Android 版本配置要求 编译版本 compilesdkversion 25 及以下目标版本 targetsdkversion 25 及以下 ( 低于 Android 8.0, 悬浮窗要求 ) 最小版本 minsdkversion 21(Android 5.0)

3 1.5 如何接入 1 初始化 ( 必须调用, 只需 1 次, 有回调 ) 初始化 Berry SDK, 所有功能的基础 调用时机 : 在应用一开始的地方 ( 建议 Application.OnCreate 或游戏入口的 Activity.OnCreate) HuyaBerryConfig huyaberryconfig = new HuyaBerryConfig.Builder().appId(" ") // 后台申请.appKey("1f7ce3cc ") // appkey 是跟 appid 匹配自动生成的.gameId(2168) // gameid 是跟 appid 匹配自动生成的.debugMode(false) // 一般传 false, 是否用测试模式 ( 需要有虎牙测试环境 ).landscapemode(true) // 横竖屏设置 ( 默认为横屏 ).isopenbugly(true) // 是否开启 SDK 中的 bugly( 默认开启 ).build(); HuyaBerry.instance().init(getApplication(), huyaberryconfig); 2 处理 Android 录屏权限请求回调 ( 必须调用, 只需 1 次 ) 录屏权限的回调 调用时机 : 在直播界面 Activity 的 onactivityresult 里 HuyaBerry.instance().onActivityResult(requestCode, resultcode, data); 3 开启直播首页 ( 必须调用, 可多次, 有回调 ) 开启直播首页 调用时机 : 直播入口处 ( 初始化之后 ) StartLiveConfig startliveconfig = new StartLiveConfig.Builder().landscapeMode(true) // 横竖屏设置 ( 如果应用初始化已传入, 这里可以不传 ).build(); HuyaBerry.instance().startLive(MyActivity.this, startliveconfig); 4 反初始化 ( 必须调用, 可多次 ) 结束直播并完成虎牙 Berry SDK 的资源回收工作

4 调用时机 : 在应用结束的地方调用或者需要结束直播的地方 HuyaBerry.instance().uninit(); 5 修改横竖屏配置 ( 可选, 可多次 ) 在直播中可修改横竖屏配置, 会影响之后显示的界面 调用时机 : 任意 HuyaBerry.instance().changeLandscapeMode(false); // 横竖屏设置,true 为横屏,false 竖屏 6 设置玩家的唯一标识 ( 可选, 可多次 ) 游戏厂商传入的唯一标识, 对应某区某服的某个特定角色, 如果没有设置, 将收不到首页开启, 直播开始, 直播结束的事件回调 调用时机 : 在开启直播首页前调用 HuyaBerry.instance().setGameAccountID("123456"); // 唯一角色标识 7 设置 SDK 事件监听 ( 可选, 只需 1 次 ) 设置 SDK 相关事件的回调, 当前版本一共 5 个回调事件 : 初始化, 首页开启, 直播开始, 直播结束, 透传数据 回调的事件为 <key,value> 形式, 定义及相关键值在 HuyaBerry.BerryEvent 类中 其中, 首页开启, 直播开始, 直播结束这 3 个事件需要设置了玩家唯一标识才会回调 调用时机 : 在初始化方法之前 ( 可以收到所有的事件回调 ) HuyaBerry.instance().setBerryEventDelegate(new HuyaBerry.BerryEvent() { public void oneventcallback(map<string, String> datamap) { if (datamap == null) { return; Log.i (TAG, datamap.tostring()); // 事件的回调信息 );

5 8 数据发送通道 ( 可选, 可多次 ) 游戏厂商传入的数据, 可以实现向观众推荐道具 皮肤, 显示玩家战绩等之类的合作功能 调用时机 : 直播中 HuyaBerry.BerryPlayerDataHelper datahelper = new HuyaBerry.BerryPlayerDataHelper(); datahelper.rolename = "Tmac50"; datahelper.serverid = " 和平服 -1"; datahelper.playerlevel = "10"; datahelper.customjson = "{\"action\":\"5 杀 \",\"description\":\" 超神 \""; HuyaBerry.instance().sendPlayerData(dataHelper); 1.6 特殊接口 以下为特殊接口, 游戏厂商自定义界面需要参考的相关接口 1 自定义界面开播接口 ( 可选, 只需 1 次 ) 游戏厂商直接调用 SDK 的开播界面, 前提 : 未开播 HuyaBerry.instance().customUIStartLive(MyActivity.this, new CustomUICallback() { public void onresultcallback(int status, BaseCallback basecallback) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { mtvcustomuicallback.settext(" 调用失败 "); ); public void onresultlistcallback(int status, List list) { 2 自定义界面获取主播信息接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 获取主播信息, 前提 : 已登录

6 HuyaBerry.instance().customUIGetAuthorInfo(this, new CustomUICallback<AuthorInfo>() { public void onresultcallback(int status, AuthorInfo authorinfo) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(authorinfo.tostring()); else { mtvcustomuicallback.settext(" 调用失败 "); ); public void onresultlistcallback(int status, List<AuthorInfo> authorinfos) { 3 自定义界面修改昵称接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 的修改昵称界面, 前提 : 已登录 HuyaBerry.instance().customUIModifyNickname(this, new CustomUICallback() { public void onresultcallback(int status, BaseCallback basecallback) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { mtvcustomuicallback.settext(" 调用失败 "); ); public void onresultlistcallback(int status, List list) { 4 自定义界面修改直播标题接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 修改直播标题, 前提 : 已登录 HuyaBerry.instance().customUIModifyTitle(this, new CustomUICallback<ErrorInfo>() { public void onresultcallback(int status, ErrorInfo errorinfo) {

7 if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { if (errorinfo == null) { mtvcustomuicallback.settext(" 调用失败 "); else { mtvcustomuicallback.settext(errorinfo.errormsg); public void onresultlistcallback(int status, List list) {, newtitle ); 5 自定义界面修改直播公告接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 修改直播公告, 前提 : 已登录 HuyaBerry.instance().customUIModifyAnnouncement(this, new CustomUICallback<ErrorInfo>() { public void onresultcallback(int status, ErrorInfo errorinfo) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { if (errorinfo == null) { mtvcustomuicallback.settext(" 调用失败 "); else { mtvcustomuicallback.settext(errorinfo.errormsg); public void onresultlistcallback(int status, List list) {, newannouncement );

8 6 自定义界面登录接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 的登录界面, 前提 : 未登录 HuyaBerry.instance().customUILogin(this, new CustomUICallback() { public void onresultcallback(int status, BaseCallback basecallback) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { mtvcustomuicallback.settext(" 调用失败 "); ); public void onresultlistcallback(int status, List list) { 7 自定义界面登出接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 修改直播标题, 前提 : 已登录 HuyaBerry.instance().customUILogout(this, new CustomUICallback() { public void onresultcallback(int status, BaseCallback basecallback) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { mtvcustomuicallback.settext(" 调用失败 "); ); public void onresultlistcallback(int status, List list) { 8 自定义界面获取清晰度接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 获取清晰度, 前提 : 已登录

9 HuyaBerry.instance().customUIGetResolution(this, new CustomUICallback<OptionalResolution>() { public void onresultcallback(int status, OptionalResolution optionalresolution) { public void onresultlistcallback(int status, List<OptionalResolution> optionalresolutions) { if (status == BaseCallback.SUCCESS) { StringBuffer sb = new StringBuffer(); for (OptionalResolution optionalresolution : optionalresolutions) { sb.append(optionalresolution.tostring()).append(", "); mtvcustomuicallback.settext(sb.tostring()); else { mtvcustomuicallback.settext(" 调用失败 "); ); 9 自定义界面设置清晰度接口 ( 可选, 可多次 ) 游戏厂商直接调用 SDK 设置清晰度, 前提 : 已登录 HuyaBerry.instance().customUISetResolution(this, new CustomUICallback() { public void onresultcallback(int status, BaseCallback basecallback) { if (status == BaseCallback.SUCCESS) { mtvcustomuicallback.settext(" 调用成功 "); else { mtvcustomuicallback.settext(" 调用失败 "); public void onresultlistcallback(int status, List list) {, resolution); 具体的接口调用参见 demo

10 接口说明 HuyaBerry 类 init application Application 接入方 app 的实例, 主要用于系统上下文环境 huyaberryconfig HuyaBerryConfig 初始化参数, 详情见下 返回值无 HuyaBerryConfig appid String 申请的 appid appkey String 与 appid 对应的 appkey gameid int 游戏 id, 跟 appid 对应分配的 debugmode boolean 是否用测试模式, 如果是, 则接入的是虎牙的测试环境 landscapemode boolean 是否用横屏模式, 如果不设置默认是横屏 isopenbugly boolean 是否开启 SDK 中的 bugly, 如果游戏中已有, 传入 false, 避免 bugly 实例的冲突 startlive startliveconfig StartLiveConfig 开播参数, 详情见下 返回值无 StartLiveConfig ishaslivelist boolean 首页是否包含列表 landscapemode boolean 是否用横屏模式, 如果不设置

11 默认是横屏 ( 会覆盖初始化的 设置 ) onactivityresult 录屏权限回调, 在接入方的当前 Activity 的 onactivityresult 回调加入即可, 参数都用 Activity 的回调参数 requestcode int 系统回调 resultcode int 系统回调 data Intent 系统回调 返回值无 uninit 反初始化, 建议在 Application.OnDestroy 里面调用 无返回值无 changelandscapemode landscapemode boolean 是否用横屏模式, 如果不设置默认是横屏 ( 会覆盖初始化的设置 ) 返回值无 setgameaccountid gameaccountid String 玩家唯一标识 返回值

12 无 setberryeventdelegate eventdelegate BerryEvent 事件回调 void oneventcallback(map<strin g, String> datamap) 返回值无 回调的事件 key 值在 BerryEvent 的定义值 暂时回调事件有 5 个 : 1) 初始化事件, 返回包括 : 事件类型 结果码 信息 示例 :{eventtype=init, resultcode=0, msg= 2) 首页启动事件, 返回包括 : 事件类型 虎牙账号唯一标识 < 未登录为 0> 游戏账号唯一 标识 SDK 启动时间 房间号 < 未认证主播房间号为 0> 示例 :{eventtype=startup, huyauid= , gameaccountid=test, startuptime= , roomid=0 3) 主播开播事件, 返回包括 : 事件类型 虎牙账号唯一标识 游戏账号唯一标识 开播时 间 房间号 示例 :{eventtype=startlive, huyauid= , gameaccountid=test, startlivetime= , roomid= ) 主播停播事件, 返回包括 : 事件类型 虎牙账号唯一标识 游戏账号唯一标识 结束时 间 本次直播时长 房间号 示例 :{eventtype=endlive, huyauid= , gameaccountid=test, endlivetime= , duration=00:02:35, roomid= ) 透传数据事件, 返回包括 : 事件类型 结果码 信息 示例 :{eventtype=sendplayerdata, resultcode=0, msg= sendplayerdata datahelper BerryPlayerDataHelper 透传的数据, 包括角色名, 服务器 id, 玩家等级, 自定义

13 返回值 无 透传数据到观众端 json customuistartlive callback CustomUICallback 调用的回调结果 返回值无 customuigetauthorinfo callback CustomUICallback 调用的回调结果 返回值 authorinfo AuthorInfo 返回的主播信息 customuimodifynickname callback CustomUICallback 调用的回调结果 返回值无 customuimodifytitle callback CustomUICallback 调用的回调结果

14 newtitle String 修改后的标题 返回值 errorinfo ErrorInfo 若失败, 具体的错误信息 customuimodifyannouncement callback CustomUICallback 调用的回调结果 newannouncement String 修改后的公告 返回值 errorinfo ErrorInfo 若失败, 具体的错误信息 customuilogin callback CustomUICallback 调用的回调结果 返回值无 customuilogout callback CustomUICallback 调用的回调结果 返回值无 customuigetresolution callback CustomUICallback 调用的回调结果

15 返回值 optionalresolution OptionalResolution 可选的清晰度 customuisetresolution callback CustomUICallback 调用的回调结果 返回值 selectedresolution Int 可选清晰度返回的清晰度数 值

16 具体接入步骤 ( 分版本 ) 接入之前最好先参照 demo 的依赖方式 3.1 Android Studio 版本接入 1. 将 berry_lib 文件复制到项目中 ( 项目根目录 ) 2. 在./setting.gradle 中增加 ':berry_lib', 引入 berry 库 3. 在./build.gradle 中 allprojects{ repositories{ 后插入以下代码 : flatdir { dirs project(':berry_lib').file('libs') 4. 在./app/build.gradle 中 android{ 后插入以下代码 : sourcesets { main.jnilibs.srcdirs = ['../berry_lib/libs'] 在文件引入 : dependencies { compile project(':berry_lib')

17 5. 在主项目的 string.xml 中加入 hyberry_webview_scheme 键值, 填入值为 huyagame + appid( 虎牙分配的 ), 如下图 :(gameid 假设为 huya_app_123) 6. 在引入的 module( 如 app) 编写代码, 检查引入是否成功, 引入 HuyaBerry 类没有报 错即引入库成功 3.2 Unity/Eclipse 版本接入 1. 将 berry_lib 文件复制到项目中 (Eclipse 与主项目同目录下,Unity 项目是 Plugins/Android 目录下 ) 2. 在 Eclipse 中 import berry_lib 的库到工程中 3. 引入 berry_lib 库,Eclipse 引入界面如下 :

18 4. 在主项目的 string.xml 中加入 hyberry_webview_scheme 键值, 填入值为 huyagame + appid( 虎牙分配的 ), 如下图 :(gameid 假设为 huya_app_123) 5. 编写代码, 检查引入是否成功, 引入 HuyaBerry 类没有报错即引入库成功

19 常见问题 4.1 接入相关 1. 找不到 HuyaBerry 类 : 检查 SDK 版本和接入流程, 是否跳过了某个流程 4.2 崩溃相关 1. 如果崩溃中有 berry 或者 hy 相关的信息, 请上报给相关的对接人员 4.3 回调相关 1. 收不到初始化回调 : 回调只能在设置之后才生效, 即设置之后才会接到后续事件的回调, 要接到初始化的回调, 需要在 init 方法之前就设置回调 2. 收不到首页启动, 主播开播, 主播停播事件, 是否未设置回调或者设置游戏唯一标识 (setberryeventdelegate 和 setgameaccountid) 4.4 全面屏适配 打出的包, 有些机型不能显示充满整个屏幕, 需添加全面屏适配代码如下 : <meta-data android:name="android.max_aspect" android:value="2.2"/> <meta-data android:name="android.vendor.full_screen" android:value="true" /> <meta-data android:name="android.notch_support" android:value="true" /> <meta-data android:name="notch.config" android:value="portrait landscape" />