Skip to content

📡WebRTC Live Broadcast allows to broadcast live video, audio and screen stream to all connected users (viewers).

License

Notifications You must be signed in to change notification settings

SushilkumarDev/Broadcast-System

Here’s a professional README file for your Broadcast System project. This document is structured to provide clear information about the project, its usage, and its features.


Broadcast System

Broadcast System

Overview

BRO Live Broadcast enables seamless live broadcasting of video, audio, and screen streams to all connected users (viewers). The system supports unlimited rooms, each allowing a broadcaster and many viewers, without time limitations. Users can also interact by sending messages to the broadcaster.


Features

  • Live Broadcasting: Stream audio, video, or screen in real-time.
  • Interactive Messaging: Viewers can send messages to the broadcaster during the broadcast.
  • Unlimited Rooms: Create multiple broadcasting rooms without time constraints.
  • Cross-Platform Support: Accessible from various devices with a web browser.

Quick Start

To get started with the BRO Live Broadcast application, you can run it using Node.js or Docker.

Prerequisites

Running with Node.js

  1. Clone the Repository:

    git clone https://github.com/SushilkumarDev/broadcast-system.git
    cd broadcast-system
  2. Setup Environment:

    # Copy .env.template to .env and edit it if needed
    cp .env.template .env
  3. Install Dependencies:

    npm install
  4. Start the Application:

    npm start

Running with Docker

  1. Clone the Repository:

    git clone https://github.com/SushilkumarDev/broadcast-system.git
    cd broadcast-system
  2. Setup Environment:

    # Copy .env.template to .env and edit it if needed
    cp .env.template .env
    # Copy docker-compose.template.yml to docker-compose.yml and edit it if needed
    cp docker-compose.template.yml docker-compose.yml
  3. Run the Application:

    docker-compose up -d

Accessing the Application

Once the server is running, you can access the application at:

The broadcaster can stream audio, video, or screen to all connected viewers and receive messages from them, while viewers can interact with the broadcaster.


Direct Joining

You can directly join a room as a Broadcaster or Viewer by specifying the room ID and your name.

As URL
Broadcaster http://localhost:3016/broadcast?id=123&name=Broadcaster
Viewer http://localhost:3016/viewer?id=123&name=Viewer

URL Parameters

Params Type Description
id string Room ID
name string User name

Embedding in an Application

To embed the MiroTalk Live Broadcast into your service or app using an iframe, use the following code snippet:

<iframe
    allow="camera; microphone; display-capture; fullscreen; clipboard-read; clipboard-write; web-share; autoplay"
    src="https://bro.mirotalk.com"
    style="height: 100vh; width: 100vw; border: 0px;"
></iframe>

License

This project is licensed under the MIT License. See the LICENSE file for more details.


Contributing

Contributions are welcome! If you would like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a pull request.

Support

If you find this project useful, consider supporting its development by buying me a coffee!

Buy Me A Coffee


Contact

For any inquiries or feedback, please contact me at [email protected].


Feel free to customize sections as needed, especially the repository URL, and add any additional information that you think might be helpful!

About

📡WebRTC Live Broadcast allows to broadcast live video, audio and screen stream to all connected users (viewers).

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published