@eyevinn/whip-web-client

中文文档
1.1.7发布于 2025/10/13Apache-2.0TypeScriptESM + CJS近 30 天下载 1.2万

WebRTC HTTP 摄取协议网络客户端 SDK

中文使用文档
文档目录5 节
  1. 开始
  2. 国家预防机制
  3. 光盘N
  4. 构建 SDK 文档 :
  5. 关于 Eyevinn 技术

WHIP 网络客户端

使用WebRTC HTTP摄入协议(WHIP)从移动或浏览器摄取WebRTC的浏览器库/SDK.

开始

示例代码 :

国家预防机制

import { WHIPClient } from "@eyevinn/whip-web-client"

const client = new WHIPClient({
  endpoint: "http://<host>/whip/broadcaster",
  opts: { debug: true, iceServers: [{ urls: "stun:stun.l.google.com:19320" }] }
});
await client.setIceServersFromEndpoint();

const videoIngest = document.querySelector<HTMLVideoElement>("video#ingest");
const mediaStream = await navigator.mediaDevices.getUserMedia({
  video: true,
  audio: true,
});
videoIngest.srcObject = mediaStream;
await client.ingest(mediaStream);

可用的选项有:

{
  endpoint: string, // URL to WHIP endpoint
  opts: {
    debug: boolean, // enable debug console logging
    iceServers: [ { urls: string, username?: string, credential?: string }], // list of STUN/TURN servers
    authkey: string, // authentication key for auth option requests
    noTrickleIce: boolean, // force to not use trickle ICE
    timeout: number, // configure a ice gathering timeout when not using trickle ICE
  }
}

光盘N

下载最新版本并在您的 HTML 中包含 javascript 文件 .

<html>
  <head><title>Webcam ingest</title></head>
  <body>
    <video autoplay muted>
    <script src="whip-client.js"></script>
    <script>
      document.addEventListener('DOMContentLoaded', function(event) {
        const client = new WHIPClient({
          endpoint: "http://<host>/whip/broadcaster",
        });
        const videoIngest = document.querySelector("video#ingest");
        navigator.mediaDevices.getUserMedia({ video: true, audio: true })
          .then(function(mediaStream) {
            videoIngest.srcObject = mediaStream;
            return client.ingest(mediaStream);
          })
          .then(function() {
            console.log("Ingesting");
          })
          .catch(function(err) {
            console.error(err);
          });
      });
    </script>
  </body>
</html>

构建 SDK 文档 :

npm run build:docs

关于 Eyevinn 技术

Eyevinn Technology是一家独立咨询公司,专门从事视频和流媒体制作. 独立的方式,我们不与任何平台或技术供应商进行商业联系.

在Eyevinn,每个软件开发者顾问都有专用预算,用于开源开发和对开源社区的贡献. 这为我们提供了创新、团队建设和个人能力发展的空间。 也给了我们公司一个为开放源码社区做出贡献的方法.

想知道更多关于"Eyevin" 和如何工作在这里。 联系我们 工作@ eyevin.se来啊!

版本与发布记录

@eyevinn/whip-web-client 共发布 25 个版本,首次发布于 2022/03/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.7latest2025/10/131.1 年前
1.1.62025/09/111.2 年前
1.1.52025/09/041.2 年前
1.1.22024/08/152 年前
1.1.12023/02/213 年前
1.1.02022/09/284 年前

关于 @eyevinn/whip-web-client 的常见问题

@eyevinn/whip-web-client 是什么?

WebRTC HTTP 摄取协议网络客户端 SDK

如何安装 @eyevinn/whip-web-client?

在项目目录运行 npm install @eyevinn/whip-web-client,或使用 pnpm add / yarn add / bun add。

@eyevinn/whip-web-client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@eyevinn/whip-web-client 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@eyevinn/whip-web-client 可以商用吗?

@eyevinn/whip-web-client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@eyevinn/whip-web-client 的下载量有多少?

根据 npm 官方下载统计,@eyevinn/whip-web-client 在 2026/10/14 – 2026/11/12 这 30 天内被下载 11,938 次,日均约 398 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@eyevinn/whip-web-client 还在维护吗?

最新版本 1.1.7 发布于 2025/10/13(1.1 年前);至今共发布 25 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/03/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。