View Source Membrane RTC Engine API Docs codecov CircleCI

Customizable Real-time Communication Engine/SFU library focused on WebRTC.


The package can be installed by adding membrane_rtc_engine to your list of dependencies in mix.exs:

def deps do
    {:membrane_rtc_engine, "~> 0.22.0"}

To use a given Endpoint, you have to include it in your list of dependencies as well:

def deps do
    {:membrane_rtc_engine, "~> 0.22.0"},
    {:membrane_rtc_engine_webrtc, "~> 0.8.0"}


For usage examples, please refer to our membrane_demo or membrane_videoroom repositories.


To make development a little easier, we have added several tasks:

  • mix test.all, which runs unit tests from the engine, unit tests from each endpoint, and endpoint integration tests,
  • mix test.webrtc.integration, which runs WebRTC Endpoint integration tests (present here),
  • To test a given Endpoint, you can use the alias mix test.ENDPOINT, e.g. mix test.webrtc,
  • To run the endpoint integration test suite, execute mix test.integration.

Copyright 2021, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0