PC 端开播弹幕玩法

本文介绍如何在 Windows 设备上开播弹幕玩法。

前提条件Copy Anchor Link

主播在 PC 端开播弹幕玩法前，请确保：

• 一个有效的声网账号以及声网项目。请参考开通弹幕服务从声网控制台获得以下信息：
  • App ID：声网随机生成的字符串，用于识别你的项目。
  • 客户 ID 和密钥：调用弹幕玩法 RESTful API 所需的 Key 和 Secret。
  • 临时 Token：Token 也称为动态密钥，用于在加入 RTC 频道时对用户鉴权。临时 Token 的有效期为 24 小时。在生产环境中，你需要参考使用 Token 鉴权在你的 App 服务端生成 Token。
• 已联系销售开通弹幕玩法。
• 你已在 App 中实现了基本的实时音视频功能，且 App 已获取相关设备的使用权限。请参考实现音视频互动。

实现流程Copy Anchor Link

PC 端开播弹幕玩法的流程如下图所示：

获取弹幕玩法客户端Copy Anchor Link

联系销售获取最新弹幕玩法客户端、对应的 gameid 和玩法支持的礼物列表。

完成礼物映射Copy Anchor Link

每个弹幕玩法提供了不同价位的付费礼物，你需要分别做不同的礼物映射。

因礼物涉及计量计费，在礼物消息 (live_gift) 推送协议中，gift_id、gift_num、gfit_value，需要严格遵守礼物列表中的对应关系。以胖可争霸为例，支持的礼物列表如下：

1. 映射 gift_id

   业务后台在把礼物 ID 在推送给声网前，需要映射成声网内建礼物 ID (gift_id)，且礼物价格保持一致。你需要根据你的业务系统中的礼物价格，寻找游戏礼物列表中同样价格的礼物 ID。例如，当你的系统中有 0.1 元的礼物 ID 为 custom_gift_id，当该礼物消息触发时，把 custom_gift_id 映射成 1001。

2. 计算 gift_value

   计算公式为 gift_value = gift_num × gift_price × 100。计算时，你需要需要把单位从元折算成分。

3. 包装 payload

   参考推送直播间消息中的礼物 payload 参数说明，将上面步骤获取的参数包装成 payload，在后续直播间互动阶段发生送礼事件时，将正确的 payload 发送给声网云游戏服务平台。

完成开播设置Copy Anchor Link

开播前，你需要在直播助手 App（例如 OBS、抖音直播助手等）中完成以下设置：

• 获取直播码：直播码为调用启动游戏服务时传入的 roomid 字段，即房间编号，是以 appid 作为前缀的全局唯一房间 ID。
• 设置直播推流地址：从开播平台获取推流地址，填写至直播助手软件中。
• 设置推流画面参数：为保证观众观看体验，声网建议推送 1080P 分辨率的视频流。具体推流画面参数需要结合实际的游戏以及网络、开播设备型号进行调整，你可以与声网技术支持沟通，从而获得最好的效果。

开始直播Copy Anchor Link

主播在本地启动弹幕玩法客户端 .exe 文件，在直播助手 App 中设置游戏采集源为游戏画面，然后单击开始直播。

在主播开播后，在业务后台（即 App 服务端）调用启动游戏服务。以 cURL 为例：

curl --location --request POST 'https://{domain}/v2/projects/{appid}/cloud-bullet-game/api/live-data/games/{gameid}/mode/pc/rooms/{roomid}:start' \
  --header 'Accept: application/json' \
  --header 'Authorization: agora token={Your_RTC_Token}' \
  --header 'Content-Type: application/json' \
  --data '{
  "rtc_cname": "string",
  "openid": "abcxxxxxxxxx321_testopenid",
  "nickname": "Player",
  "avatar_url": "http://127.0.0.1/xxxxx.jpg"
}'

推送直播间消息Copy Anchor Link

根据直播间中获取到的礼物、评论和点赞消息，在业务后台调用推送直播间消息，将这些消息发送至声网云游戏服务平台。以 cURL 为例：

# 以推送礼物消息为例
curl --location --request POST 'https://{domain}/v2/projects/{appid}/bullet-game/api/live-data/games/{gameid}/rooms/${roomid}/msgType/live_gift:push' \
  --header 'Accept: application/json' \
  --header 'Authorization: agora token={Your_RTC_Token}' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "payload": {
      "msg_id": "abcxxxxxxxxx321_12345678",
      "openid": "abcxxxxxxxxx321_testopenid",
      "gift_id": 10001,
      "gift_num": 10,
      "gift_value": 10000,
      "avatar_url": "http://127.0.0.1/xxxxx.jpg",
      "nickname": "Player",
      "timestamp": 1699068964
    },
  }
]'

结束直播Copy Anchor Link

主播下播后，在业务后台调用关闭游戏服务。以 cURL 为例：

curl --location --request POST 'https://{domain}/v2/projects/{appid}/cloud-bullet-game/api/live-data/games/{gameid}/mode/pc/rooms/{roomid}:stop' \
  --header 'Accept: application/json' \
  --header 'Authorization: agora token={Your_RTC_Token}' \
  --header 'Content-Type: application/json'

参考信息Copy Anchor Link

开发注意事项Copy Anchor Link

• 协议字段中的 msgid，roomid 和 openid 需要在声网侧保持全局唯一，建议格式为 <appid>_xxxx 的方式。对于 msg_id，由于同一时间可能存在多用户发送消息，可以通过自增保持唯一性。
• roomid 在主播侧暴露存在安全风险，建议每次开播生成的 roomid 为不重复的随机值。

相关文档Copy Anchor Link

• 启动游戏服务
• 关闭游戏服务
• 推送直播间消息
• 响应状态码
• API 调用限制