Membrane RTC Engine
Client and server libraries for Membrane RTC Engine.
Documentation
Documentation of client library is available at https://hexdocs.pm/membrane_rtc_engine/js
Documentation of server library is available at https://hexdocs.pm/membrane_rtc_engine
Installation
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.1.0-alpha.2"}
]
end
Usage
For usage examples, please refer to our membrane_demo repository.
Developing
To make the development a little easier, we augmented mix compile
and mix docs
tasks so that mix compile
also installs npm dependencies and compiles TypeScript code
and mix docs
also generates documentation for TypeScript code.
Thanks to this, there is no need to include compiled JS code in priv/static
. It will be generated each time mix compile
is called.
TypeScript documentation will be generated under doc/js/
.
Copyright and License
Copyright 2021, Software Mansion
Licensed under the Apache License, Version 2.0