# umrtc 视频会议

**Repository Path**: tangcc_admin/umrtc-video-conference

## Basic Information

- **Project Name**: umrtc 视频会议
- **Description**: 简便、易用、轻量的视频会议系统。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: develop
- **Homepage**: https://open.umnet.cn/umrtc
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 18
- **Created**: 2023-07-01
- **Last Updated**: 2023-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 联信视频会议 UMRTC 2.0

> 简便、易用、轻量的视频会议系统。本项目为客户端源码。需要自建私有云视频会议服务器请[联系我们](docs/技术支持/联系我们.md)。

## 概述

联信视频基于webrtc技术，将视频通话连接过程进行封装简化，提供客户端SDK用于快速搭建视频会议系统。服务器支持自主搭建私有云，支持国产Linux操作系统, 以及Docker快速部署。

## 系统结构

#### 1. 系统框架图

![系统框架图](docs/imgs/umvideo2.svg)

客户端会与服务器进行SFU连接和信令连接。如果用户选择了P2P模式，则客户端之间也会自动建立点对点的Mesh网络。

#### 2. SFU网络图示意图

![SFU网络图](docs/imgs/sfu.svg)

#### 3. Mesh网络图示意图

![Mesh网络图](docs/imgs/p2p.svg)

## 特点

联信视频基于SFU/P2P混合模式进行视频通讯，可选“仅SFU/仅P2P/SFU优先/P2P优先”四种模式。 这些模式区别如下：

1. 仅SFU：这种模式下，视频会议房间内的端对端全部使用SFU模式，即通过服务器中转分发的方式进行视频通讯。特点是建立连接稳定，但是对服务器带宽要求高，对客户端带宽和性能要求低。
2. 仅P2P：这种模式下，视频会议房间内的端对端全部使用P2P模式，即点对点直连方式进行视频通话。特点是连接建立不稳定，同时支持的端不多。但是对服务器几乎无要求，对客户端性能和带宽要求高，且客户端所处网络必须支持NAT穿透。
3. SFU优先：混合模式，SFU优先。如果P2P可以打通通道，则把SFU通道替换为P2P。特点是可在SFU通讯过程中同时支持P2P连接。这也是联信视频的默认模式。
4. P2P优先：混合模式，P2P优先。如果P2P通道建立失败，则改为建立SFU通道代替P2P。特点是开始时对服务器性能要求低，连接由于有SFU进行转发，所以比仅P2P要稳定，对客户端性能和带宽要求高。另外视频建立所需时间也比SFU优先要慢一些（默认30秒超时或网络连接出错时，自动切换到SFU模式）。

## 实例

### [WebAPI调用](docs/进阶/WebAPI.md)

第三方可使用web api快速创建视频房间进行视频沟通，通过链接的几个参数来控制创建的房间，以便快速入会。

链接格式：

```
https://open.umnet.cn/umrtc/#/videoMeeting?h=房间号&t=会议类型&m=链接模式&n=名字
```

参数说明：
- h: 房间号， 长度6位以上的字母、数字组合
- t：video、audio两种类型，可指定创建“视频会议房间”和“语音会议房间”
- m：网络链接方式，sfufirst（默认)、sfu、p2pfirst、p2p, 参考[说明](README.md)
- n：用户名字, 如：张三，李四

示例：
```
// 创建一个房间为：名称：room001， 类型：video,  网络： sfufirst,  用户名: 张三
https://open.umnet.cn/umrtc/#/videoMeeting?h=room001&t=video&m=sfufirst&n=张三

// 加入房间room001， 并以用户名为：李四 加入
https://open.umnet.cn/umrtc/#/videoMeeting?h=room001&t=video&m=sfufirst&n=李四

// 此时张三与李四就可以直接通话了
```

### [视频会议](https://open.umnet.cn/umrtc)

<a href="https://open.umnet.cn/umrtc" target="_blank">
<img src="docs/imgs/login.png" alt="创建会议室"/>
<img src="docs/imgs/room.png" alt="会议进行中1"/>
<p style="width:100%; text-align:center;">【点击体验】</p>
</a>

### [在线直播](https://open.umnet.cn/dapp/dappLink?appid=915efde97e151f5e1eba44a545934f79&modid=7f3f2ba6b45f9494a3cc39d68c974e4f)

<a href="https://open.umnet.cn/dapp/dappLink?appid=915efde97e151f5e1eba44a545934f79&modid=7f3f2ba6b45f9494a3cc39d68c974e4f" target="_blank">
<img src="docs/imgs/zhibo.png" alt="创建直播"/>
<img src="docs/imgs/zhiboroom2.png" alt="直播进行中2"/>
<p style="width:100%; text-align:center;">【点击体验】</p>
</a>


## SDK开发文档

[在线查看](https://open.umnet.cn:40000/docs)

- 入门
  - [简介](docs/README.md) 
  - [快速开始](docs/入门/快速开始.md)
  - [视频页面结构](docs/入门/视频页面结构.md)

- 进阶
  - [定制化](docs/进阶/定制化.md)
  - [API参考](docs/进阶/Api参考.md)

- 服务器
  - [搭建私有云](docs/服务器/搭建私有云.md)
  - [自定义配置](docs/服务器/自定义配置.md)

- 技术支持
  - [联系我们](docs/技术支持/联系我们.md)

## 构建与开发

### client 源码打包

```bash
npm install     # 安装依赖
npm run build   # 编译
npm run serve   # 进入开发模式，监听在8080端口
```

### document 文档打包

```bash
npm i docsify-cli -g  # 如果你没有安装过的话，先安装docsify-cli工具
docsify init ./docs   # 初始化文档，仅创建时使用
docsify serve docs    # http://localhost:3000 查看文档
docsify generate docs # 生成侧边栏导航
```

### Customize configuration 自定义项目配置

VUE：查看 [Configuration Reference](https://cli.vuejs.org/config/).

私有云：修改`public/static/serverconfig.js`


## 源码文件说明

[源码文件结构](source.md)

## 开源协议

[MIT](LICENSE)

## 联系与支持

#### 青岛联合汇信科技有限公司

#### 技术支持：0532-80668101

#### 联系邮箱：18605328973@126.com

#### 在线联系：https://open.umnet.cn/um/link?u=6000339828

#### 公司网址：https://www.umnet.cn