SkyRTC 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01138/article/details/141416347

SkyRTC 开源项目教程

SkyRTCA server-side webRTC lib to build real-time communications in browser项目地址:https://gitcode.com/gh_mirrors/sk/SkyRTC

1. 项目的目录结构及介绍

SkyRTC 项目的目录结构如下：

SkyRTC/
├── LICENSE
├── README.md
├── client
│   ├── index.html
│   ├── main.js
│   └── style.css
├── package.json
├── server
│   ├── index.js
│   └── skyrtc.js
└── yarn.lock

目录结构介绍

LICENSE: 项目许可证文件。
README.md: 项目说明文档。
client: 客户端相关文件夹。
- index.html: 客户端主页面。
- main.js: 客户端 JavaScript 文件。
- style.css: 客户端样式文件。
package.json: Node.js 项目配置文件。
server: 服务器端相关文件夹。
- index.js: 服务器启动文件。
- skyrtc.js: 服务器核心逻辑文件。
yarn.lock: Yarn 包管理器生成的锁定文件。

2. 项目的启动文件介绍

SkyRTC 项目的启动文件是 server/index.js。这个文件负责启动服务器并初始化 SkyRTC 实例。

启动文件内容概览

const SkyRTC = require('./skyrtc').listen(3000);

SkyRTC.on('connection', function(socket) {
    console.log('New connection');
    socket.on('create or join', function(room) {
        console.log('Create or join to room', room);
        const myRoom = SkyRTC.rooms[room] || [];
        const numClients = myRoom.length;

        if (numClients === 0) {
            socket.join(room);
            socket.emit('created', room, socket.id);
        } else if (numClients === 1) {
            socket.join(room);
            socket.emit('joined', room, socket.id);
        } else {
            socket.emit('full', room);
        }
    });
});

启动文件功能介绍

引入 SkyRTC 模块: 通过 require('./skyrtc') 引入 SkyRTC 模块。
监听端口: 使用 listen(3000) 方法监听 3000 端口。
处理连接事件: 当有新连接时，触发 connection 事件，并处理房间的创建和加入逻辑。

3. 项目的配置文件介绍

SkyRTC 项目的主要配置文件是 package.json。这个文件包含了项目的元数据和依赖项。

配置文件内容概览

{
  "name": "SkyRTC",
  "version": "1.0.0",
  "description": "A simple WebRTC room server",
  "main": "server/index.js",
  "scripts": {
    "start": "node server/index.js"
  },
  "dependencies": {
    "express": "^4.17.1",
    "socket.io": "^2.3.0"
  },
  "author": "LingyuCoder",
  "license": "MIT"
}