Skip to content
Nmoleo64 edited this page Jun 18, 2021 · 15 revisions

Welcome to the Youtube-Sync Wiki!

About the Project

Youtube-Sync is a project that aims to sync up video streams to allow students at the University of Illinois to view prerecorded lectures together in real time. This project uses the Video.js API.

As of now, the video player can support up to 4 people watching at the same time. Any user can pause/play the video or skip ahead/behind and these changes will be synchronized between all users.

Future features include websockets functionality to reduce server load and a built-in chat.

Wiki Table of Contents

Python Code Documentation

  • app.py - main Python script to run Flask webserver, handle websockets request, and manage users
  • The users Variable - stores a list of current users and information about them
  • logger.py - Python script to handle logging data to a .log file
  • validation.py - Validates a specified username
  • The HandleMessage function - Handles all server-side WebSockets messages

JavaScript Code Documentation

  • video-player.js - The main page of the application where the video runs. Sends data to the server
  • video-join-page.js - The page where users log in to a session and choose their username
  • MessageHandler.js - Handles received websockets messages from the server

Table of Contents

Wiki Homepage

Python Code Documentation

JavaScript Code Documentation

Clone this wiki locally