@antmedia/videojs-webrtc-plugin

中文文档
2.0.1发布于 2026/08/27MITESM + CJS构建来源已验证近 30 天下载 3487

以 Ant-Media Server 通过 WebRTC 流线

中文使用文档
文档目录11 节
  1. 目录
  2. 快速启动
  3. 安装
  4. 使用量
  5. 源对象
  6. <script> 标记
  7. 浏览/共同JS
  8. 要求JS/AMD
  9. 处理错误召回
  10. 许可证
  11. 问题

视频-网络插件

在蚂蚁媒体服务器上查看流的插件 。 改变流的解析度也有其功能

目录

快速启动

要快速安装 videojs-webrtc-plugin 并按以下步骤在服务器上本地运行.

  • 清除本地系统上的存储器.

    git clone https://github.com/ant-media/videojs-webrtc-plugin.git
    
  • 复制寄存器后,运行以下命令以在当地构建和运行项目.

    npm install
    
    npm run build
    
    npm run start
    

在项目运行后,它将运行在任何特定的端口上(例如,端口1000),这样您就可以在http://localhost:1000或http://IP-address:1000上访问,如果运行在任何云端服务器上.

插件在浏览器中运行后,将websocket URL替换为您服务器在WS流链接中的websocket URL并加载流. 检查 流星图 参考部分.

安装

为了将插件集成到您的外部工程中,请使用下面的命令来安装软件包.

npm install --save @antmedia/videojs-webrtc-plugin

使用量

要将 videojs-webrtc-plugin 包含在您的网站或网络应用程序中,请使用以下任何方法.

源对象

流星图

Ant-MediaServer 流地址格式 :

ws://[ant-address]/[app]/[streamId].webrtc?token=[token(opt)]&subscriberId=[subscriberId(opt)]&subscriberCode=[TOTP-code(opt)]

例如:

ws://12.23.322.157:5080/LiveApp/stream1.webrtc

附加参数:-

  • token (optional) - 为溪流生成的一次性标志(如果溪流受到一次性标志保护机制的保护)
  • subscriberId (optional) - 订阅者 ID。 如果该流受到 TOTP 密码的保护, 则需要
  • subscriberCode (optional) - 生成了 TOTP 密码 。 如果流被 TOTP 密码保护,则需要

冰匠们

JSON字符串格式的 Ice-servers (STUN, TURN) 阵列以建立WebRTC连接.

例如:

'[ { "urls": "stun:stun1.l.google.com:19302" } ]'

<script> 标记

这是最简单的案例。 以任何你喜欢的方式获取脚本并包含插件 之后 包含 视频.js,这样 videojs 现可提供全球服务.

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-webrtc-plugin.min.js"></script>

<div id="video_container">
    <video id=my-video width=960 height=540 class="video-js vjs-default-skin" controls>
        <source
           src="ws://localhost:5080/LiveApp/stream1.webrtc" iceServers = '[ { "urls": "stun:stun1.l.google.com:19302" } ]'
           >
      </video>
</div>
<script>
  var player = videojs('my-video');
</script>

浏览/共同JS

在使用浏览器时,通过 npm 安装 videojs-webrtc-plugin require 插件,如您想要其它模块.

var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-webrtc-plugin');

var player = videojs('my-video');

player.src({
  src: 'ws://localhost:5080/LiveApp/stream1.webrtc',
  iceServers: '[ { "urls": "stun:stun1.l.google.com:19302" } ]'
});

要求JS/AMD

使用 RequestJS( 或另一个 AMD 库) 时, 以您喜欢的方式获取脚本 require 通常情况下的插件 :

require(['video.js', 'videojs-webrtc-plugin'], function(videojs) {
  var player = videojs('my-video');

  player.src({
    src: 'ws://localhost:5080/LiveApp/stream1.webrtc',
    iceServers: '[ { "urls": "stun:stun1.l.google.com:19302" } ]'
  });
});

处理错误召回

Ant-MediaServer具有处理后端出错的功能. 要发现错误, 您需要订阅事件“ ant- error ” :

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-webrtc-plugin.min.js"></script>
<script>
  var player = videojs('my-video');

  player.src({
    src: 'ws://localhost:5080/LiveApp/stream1.webrtc',
    iceServers: '[ { "urls": "stun:stun1.l.google.com:19302" } ]'
  });
  player.on('ant-error', function(event, errors) {
    console.log(errors);
  });
</script>

许可证

MIT. 版权 (c) 蚂蚁媒体

问题

如有问题,请在 蚂蚁-媒体-服务器仓库

版本与发布记录

@antmedia/videojs-webrtc-plugin 共发布 13 个版本,首次发布于 2022/02/24;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.1latest2026/08/272 个月前
1.3.32025/05/121.5 年前
1.3.22025/02/011.8 年前
1.3.12024/10/082 年前
1.3.02024/10/062 年前
1.2.32024/09/072 年前

关于 @antmedia/videojs-webrtc-plugin 的常见问题

@antmedia/videojs-webrtc-plugin 是什么?

以 Ant-Media Server 通过 WebRTC 流线

如何安装 @antmedia/videojs-webrtc-plugin?

在项目目录运行 npm install @antmedia/videojs-webrtc-plugin,或使用 pnpm add / yarn add / bun add。

@antmedia/videojs-webrtc-plugin 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/antmedia__videojs-webrtc-plugin 是否存在。

@antmedia/videojs-webrtc-plugin 支持 ESM 还是 CommonJS?

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

@antmedia/videojs-webrtc-plugin 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=14。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@antmedia/videojs-webrtc-plugin 可以商用吗?

@antmedia/videojs-webrtc-plugin 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@antmedia/videojs-webrtc-plugin 的下载量有多少?

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

@antmedia/videojs-webrtc-plugin 还在维护吗?

最新版本 2.0.1 发布于 2026/08/27(2 个月前);至今共发布 13 个版本,其中过去 12 个月发布了 1 个;首次发布于 2022/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。