seaduboi/broadcast-box

Broadcast Box Docker镜像

镜像概述

Broadcast Box是一款基于WebRTC技术的广播工具，旨在实现亚秒级延迟的音视频广播。它设计简洁易用且易于修改，展示了广播领域的前沿技术，支持多视角直播、最新视频编解码及P2P传输，让任何人都能轻松开展低延迟广播。

核心功能与特性

亚秒级延迟

采用WebRTC替代传统RTMP和HLS协议，实现最快的广播体验，延迟可低至亚秒级，满足实时互动需求。

最新视频压缩技术

通过WebRTC支持最新视频编解码器（如AV1），在相同视频质量下可减少50%的带宽需求，提升传输效率。

多视角广播

WebRTC允许在同一会话中上传多个视频流，支持多摄像头视角广播或实时互动视频体验，丰富直播内容形式。

广播者提供转码

广播者可上传不同质量级别的视频流，无需服务器承担高昂转码成本，同时为观众提供适配体验，平衡成本与质量。

人人可广播

支持OBS等专业广播软件或直接通过浏览器开播，无需复杂的比特率和编解码器配置，新手也能一键启动直播，降低使用门槛。

Peer-to-Peer（P2P）支持

无需公网IP或端口转发即可广播视频，通过WebRTC的NAT穿越技术，用户可在本地运行OBS并分享视频至全球；也支持P2P拉取其他广播者流，实现亚秒级联流。

使用场景与适用范围

适用于需要低延迟实时互动的广播场景，包括：

• 实时游戏直播与解说
• 多视角活动直播（会议、演出、体育赛事）
• 实时互动教学与培训
• 低成本P2P直播（无需专用服务器）
• 亚秒级延迟的协作直播（如远程嘉宾联线）

使用方法与配置说明

在线使用

可直接使用公共实例：b.siobud.com，无需本地部署。

广播

使用OBS广播

1. 打开OBS，进入设置 > 流，配置以下参数：

   • 服务：WHIP
   • 服务器：公共实例填写https://b.siobud.com/api/whip；本地部署填写http://<你的IP>:8080/api/whip
   • 流密钥：自定义任意字符串（广播与播放使用同一密钥）

2. （可选）优化延迟至亚秒级：

   • 进入设置 > 输出，设置编码器为x264，调谐为zerolatency（零延迟）

3. 点击开始推流即可启动广播。

使用GStreamer（命令行）

通过示例脚本广播测试源或摄像头/麦克风输入：

shell
# 测试源广播
./examples/gstreamer-broadcast.nu http://localhost:8080/api/whip testStream1

# 摄像头源广播（需连接摄像头）
./examples/gstreamer-broadcast.nu http://localhost:8080/api/whip testStream1 v4l2

依赖：需安装gstreamer-1.0及good,bad,ugly插件和gst-plugins-rs。

播放

广播内容通过以下方式访问：

• 若流密钥为StreamTest，公共实例播放地址为https://b.siobud.com/StreamTest；本地实例为http://<你的IP>:8080/StreamTest
• 也可访问首页，输入流密钥直接播放。

本地部署指南

Docker部署

本地环境（macOS/Windows Docker）

因Docker桌面版运行在NAT环境，需启用UDP复用：

shell
docker run -e UDP_MUX_PORT=8080 -e NAT_1_TO_1_IP=127.0.0.1 -p 8080:8080 -p 8080:8080/udp seaduboi/broadcast-box

访问地址：http://localhost:8080

云服务器（AWS等）

需使用--net=host模式以支持随机UDP端口监听：

shell
docker run --net=host -e INCLUDE_PUBLIC_IP_IN_NAT_1_TO_1_IP=yes seaduboi/broadcast-box

Docker Compose部署

提供自动HTTPS（Let's Encrypt）和自动更新（Watchtower），适合VPS/云服务器快速部署：

1. 导出服务器URL：

   shell
   export URL=my-server.com
   

2. 启动服务：

   shell
   docker-compose up -d
   

环境变量配置

后端可通过以下环境变量自定义配置：

启动时网络测试

Docker环境下，Broadcast Box默认启动网络测试，验证WebRTC流量是否可正常建立，若配置错误则服务不启动。

• 测试启用提示：

  console
  NETWORK_TEST_ON_START is enabled. If the test fails Broadcast Box will exit.
  See the README.md for how to debug or disable NETWORK_TEST_ON_START
  

• 测试通过：

  console
  Network Test passed.
  Have fun using Broadcast Box
  

• 测试失败：

  console
  Network Test failed.
  Network Test client reported nothing in 30 seconds
  Please see the README and join Discord for help
  

禁用测试：设置环境变量NETWORK_TEST_ON_START=false。

设计

后端暴露以下核心端点：

• /api/whip：启动WHIP会话（通过WebRTC广播视频）
• /api/whep：启动WHEP会话（通过WebRTC播放视频）
• /api/status：查看所有活动WHIP流状态（可通过DISABLE_STATUS禁用）