Skip to content

📡 MiroTalk 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/mirotalkbro

Repository files navigation

MiroTalk WebRTC Live Broadcast


MiroTalk BRO Live Broadcast allows to broadcast live video, audio and screen stream to all connected users (viewers) and receive messages from them. Can handle unlimited rooms, without time limitations, each having a broadcast and many viewers.


Explore MiroTalk BRO



Quick Start

Start the app using nodejs:

# Copy .env.template in .env and edit it if needed
$ cp .env.template .env
# Install dependencies
$ npm install
# Run the app
$ npm start

Start the app using docker - docker-compose and optional official image:

docker

# Copy .env.template in .env and edit it if needed
$ cp .env.template .env
# Copy docker-compose.template.yml in docker-compose.yml and edit it if needed
$ cp docker-compose.template.yml docker-compose.yml
# Get official image from Docker Hub
$ docker pull mirotalk/bro:latest
# Run the image in a container
$ docker-compose up #-d

Server up and running

Server is running {
  home: 'http://localhost:3016',
  broadcast: 'http://localhost:3016/broadcast?id=123&name=Broadcaster',
  viewer: 'http://localhost:3016/viewer?id=123&name=Viewer',
  viewerHome: 'http://localhost:3016/home?id=123'
}

The app should now be running on your http://localhost:3016, you can choose if join room as a Broadcaster or Viewer.

The Broadcaster stream the audio, video or screen to all connected viewers and can receive messages from them.

The Viewer get the audio, video or screen that is streamed from the broadcaster and can send messages to it.

Direct Join

You can direct join room as broadcaster or viewer 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
Params Type Description
id string Room Id
name string User name
Embedding

Embedding MiroTalk Live Broadcast into a service or app using an iframe.

<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>
Documentations
Credits
License

AGPLv3

MiroTalk BRO is free and open-source under the terms of AGPLv3 (GNU Affero General Public License v3.0). Please respect the license conditions, In particular modifications need to be free as well and made available to the public. Get a quick overview of the license at Choose an open source license.

To obtain a MiroTalk BRO license with terms different from the AGPLv3, you can conveniently make your purchase on CodeCanyon. This allows you to tailor the licensing conditions to better suit your specific requirements.


About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published