This application allows you to stream your webcam video to any web browser on your LAN (and probably over the internet). I created this because I occasionally need to watch for packages or people to arrive at my house but don't really want to set up a permanent camera or keep looking out of or running over to the window every 5 minutes.
NOTE: The server-side of this application only works on Linux.
The browser client for this application is a basic website written in TypeScript, HTML, and CSS. Vite is used as a local development server and asset bundling. It uses the hls.js library to handle playing and buffering the HLS video streams broadcasted by the server.
The server for this application is written in Go and uses HTTP Live Streaming (HLS) to broadcast a host computer's webcam.
This is achieved by using ffmpeg to transcode video from
the host's webcam into .m3u8 playlist files and .ts segment files, which are
then served to the client via the server's /stream/ HTTP endpoint.
To build the application into the build subdirectory, run the supplied build script:
./script/build <HLS server URL>To get hot reloads in the browser whilde developing the frontend code, run:
npm run devAdditionally, you can set the HLS server URL by setting the
VITE_HLS_SERVER_URL environment variable to a whatever URL the HLS server is
accessible from (e.g. http://10.0.0.1:8080 for a LAN URL, and
https://mydomain.com for a potential WAN URL).
To run the backend server with reloads on code changes, you can either run the provided script:
./scripts/hls-server-devor navigate to the hls-server subdirectory and running air
manually:
cd hls-server
airYou can also just run the server without reloads on code changes by either running
./scripts/start-hls-serveror navigating to the hls-server subdirectory and running the server with go run:
cd hls-server
go run .- Implement a mechanism to check the max webcam resolution, frame rate, etc.
- Control webcam resolution, frame rate, etc.
- Dockerize the application, publish on ghcr.io