Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fishjam-dev/membrane_rtc_engine
Customizable Real-time Communication Engine/SFU library focused on WebRTC.
https://github.com/fishjam-dev/membrane_rtc_engine
membrane multimedia-systems realtime-communication sfu webrtc
Last synced: 3 months ago
JSON representation
Customizable Real-time Communication Engine/SFU library focused on WebRTC.
- Host: GitHub
- URL: https://github.com/fishjam-dev/membrane_rtc_engine
- Owner: fishjam-dev
- License: apache-2.0
- Created: 2021-07-01T09:57:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T11:48:01.000Z (8 months ago)
- Last Synced: 2024-06-14T15:43:30.561Z (8 months ago)
- Topics: membrane, multimedia-systems, realtime-communication, sfu, webrtc
- Language: Elixir
- Homepage:
- Size: 101 MB
- Stars: 133
- Watchers: 8
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# This Repository Has Been Archived
Please visit the new repository under the [Fishjam Cloud](https://fishjam.io/) organization for the latest updates and contributions:
[](https://github.com/fishjam-cloud/membrane_rtc_engine)
# Membrane RTC Engine
Customizable Real-time Communication Engine/SFU library focused on WebRTC.
## Usage
For usage examples, please refer to:
- [the `examples/` directory](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/examples/) of this repository,
- our [membrane\_videoroom](https://github.com/membraneframework/membrane_videoroom) repository,
- our [jellyfish](https://github.com/jellyfish-dev/jellyfish) repository.
## Repository structure
This repository currently holds the following packages:
- [`engine`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/engine) -
RTC Engine, the main package responsible for exchanging media tracks between Endpoints,
- [`webrtc`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/webrtc) -
WebRTC Endpoint, responsible for establishing a connection with some WebRTC client (mainly browser) and exchanging media with it,
- [`hls`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/hls) -
HLS Endpoint, responsible for receiving media tracks from all other Endpoints and saving them to files by creating HLS playlists,
- [`rtsp`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/rtsp) -
RTSP Endpoint, responsible for connecting to a remote RTSP stream source and sending the appropriate media track to other Endpoints,
- [`file`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/file) -
File Endpoint, responsible for reading track from a file, payloading it into RTP, and sending it to other Endpoints,
- [`sip`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/sip) -
SIP Endpoint, responsible for establishing a connection with some SIP device (e.g. phone) and exchanging media with it,
- [`recording`](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/recording) -
Recording Endpoint, responsible for saving incoming tracks to pointed storages.
For more info about a given Endpoint, refer to its documentation.
Each Endpoint is a separate package with its own source files, dependencies and tests.
To use a certain Endpoint in your app, you have to declare it in your dependencies list (as well as
the Engine), e.g.
```elixir
def deps do
[
{:membrane_rtc_engine, "~> 0.22.0"},
{:membrane_rtc_engine_webrtc, "~> 0.8.0"}
]
end
```
[The `integration_test/` directory](https://github.com/jellyfish-dev/membrane_rtc_engine/tree/master/integration_test)
contains test scenarios utilising multiple Endpoints of different types.