虎牙开放平台文档

开发说明

3.1、技术框架

2023 08 17 18 05 11

3.2、技术流程

2023 08 08 15 57 55

3.3、前置说明

  • windows 7及以上系统
  • 虎牙主播端PC版本>=5.12.24.0

3.4、平台接入

现在从创建小程序到在直播间预览,对整个接入流程进行说明。

3.4.1、配置小程序

点击左侧菜单的版本管理,点击右上角创建新版本按钮创建一个版本:

2023 10 10 15 11 26

输入版本号,点击确定按钮完成版本创建。点击该版本右上角的菜单按钮,在弹出的菜单中点击设置,进入版本设置界面。点击上方程序配置标签:

2023 10 12 16 24 13

拷贝以下开发配置和终端代码(小程序代码),拖动到相关区域即可完成配置:

2023 10 10 15 22 53

推荐在开发配置中,单击PC主播端-面板的宽高配置旁边的“修改”按钮:

2023 10 27 16 14 22

修改宽高配置为:

  • width:430px
  • height:292px

默认的小程序模版会显示以下信息:

2023 10 12 16 54 41

2023 10 11 15 35 10

可以根据需求进行填写和上传。

3.4.2、应用程序对接

EXE可以通过以下方式使用虎牙平台的相关资源:

3.4.2.1、启动参数

启动参数有两种:

  • 默认参数,平台会把一些直播间相关的数据作为启动参数传入到EXE中,现在支持的参数有:
    • roomid:当前主播所在的房间号(用引号包裹)
    • profileid:当前主播的unionId(用引号包裹)
    • userid:当前用户的unionId(用引号包裹)
  • 自定义参数,可以在小程序配置中指定自定义的启动参数,具体的设置方式参考下文的“开发者中心”部份内容。

3.4.2.2、弹幕礼物消息接入

参考开放API相关内容接入虎牙平台开放API,具体的能力参考API列表

3.4.3、上传应用程序包

EXE打包完成后,可以前往开发者中心访问弹幕玩法页签(需申请权限),上传应用程序包(可以用这个GameDemo.zip)以及填写相关信息:

2023 10 12 17 12 20

填写相关信息:

  • EXE包地址链接:点击右侧上传按钮上传应用程序包,需要把EXE压缩成zip包。注意:EXE必须放在压缩包根目录
  • 启动文件:EXE的完整文件名
  • 包备注:可选
  • 启动参数:可选,命令行参数格式,会在启动的时候带上
  • 是否开启云启动:激活之后可以启用云启动功能(需额外申请权限)

填写完毕后点击保存配置,成功后就可以准备在虎牙主播端预览了。

3.4.3.1、云启动状态

如果上述配置选择激活云启动,该版本的卡片会出现云启动状态相关的信息:

2023 10 12 17 15 17

点击查询,可以查询部署状态:

2023 10 12 17 15 29

包括以下几种状态:

  • 成功:EXE已经成功部署到云端
  • 未部署:EXE未部署到云端,可以点击部署按钮手动部署

3.4.4、在直播间预览

点击左侧菜单版本管理,在上述对应版本的菜单中点击提交测试,等待构建完毕:

2023 10 12 17 15 42

构建完成后,按照快速开始中的在直播间预览点击版本菜单中的安装按钮,添加到对应直播间后,即可在虎牙PC主播端进行预览。打开虎牙PC主播端,进入准备开播画面,点击左侧面板中的小程序按钮:

2023 10 10 17 09 01

点击其中“我的”,拉到最后可以找到对应的版本:

2023 10 12 17 00 46

点击打开小程序,如果上述云启动未激活,界面只有一个本地启动的按钮:

2023 10 12 17 02 18

如果是激活云启动,界面会有两个按钮:

2023 10 12 17 01 22

点击本地启动,完成初始化工作后,会把EXE下载到本地打开。点击云启动,完成初始化工作后,会以云启动的方式打开EXE,体验跟本地打开是一样的:

2023 12 26 10 37 33

这个Demo可以直接从EXE调用弹幕玩法相关的SDK接口,如:

理论上从EXE可以直接调用小程序的JS SDK的任意一个接口,如hyExt.context.getLiveInfo。点击“直播间信息”,会调用这个接口并把返回的信息外显到EXE:

2023 12 26 10 42 24

3.5、相关链接