Add an actual explanation of what this does

Months after more or less "1.0" is the right time to do this; yup.
This commit is contained in:
Trysdyn Black 2025-02-23 16:55:06 -08:00
parent a0b5b11e4a
commit 074478f104

View file

@ -8,6 +8,24 @@ OvenMediaEngine management middleware
![A sample two-stream view of OvenEmprex's default interface](example/sample.png 'Sample screenshot') ![A sample two-stream view of OvenEmprex's default interface](example/sample.png 'Sample screenshot')
# What Is It?
OvenEmprex presents a set of web pages to allow convenient simple display of RTMP and WebRTC streams ingested in an [OvenMediaEngine](https://github.com/AirenSoft/OvenMediaEngine) server in various forms. The most prominent display is a mode closely resembling screen share or meeting software, which automatically populates each stream into an arranged grid. If you've done multi-user screen or video shares with Discord, Webex, or similar, this view will feel pretty familiar.
Additional display modes allow for dedicated views of individual streams, easily populating and configuring Javascript WebRTC players to display streams on your OvenMediaEngine Server, without the need to know any code.
OvenEmprex's goal is to provide a dual purpose frontend for OvenMediaEngine for...
- Communities that want to have their own video share system, so as not to rely on more centralized options like Discord, Webex, etc
- Event production experts who want an easy to use pipeline for receiving live streams and mixing them into a video production project for remote podcasting, talk shows, online video game competitions, etc
OvenEmprex also handles additional authentication and management of an OvenMediaEngine server. Tooling provides a convenient management webpage to expose API-only features such as forced disconnections, and (eventually) recording to server disk. This management interface also exposes the ability to allow/disallow specific stream keys and IP addresses to allow a server admin to better moderate a video stream server.
Finally, management tools provides some limited introspection into stream quality and health to troubleshoot streaming software or network problems.
OvenEmprex and OvenMediaEngine are the software tools powering the Kusogrande video game tournament. They're used to collate and centralize player livestreams into one place for the host to capture, manipulate, and mix into a single view for broadcast to Twitch.
# Requirements # Requirements
This project tries to be pretty lean. Requirements should be roughly... This project tries to be pretty lean. Requirements should be roughly...