https://github.com/software-mansion-labs/elixir-janus-plugin-videoroom
Bindings for Janus Gateway for the Elixir language - videoroom plugin API
https://github.com/software-mansion-labs/elixir-janus-plugin-videoroom
Last synced: about 2 months ago
JSON representation
Bindings for Janus Gateway for the Elixir language - videoroom plugin API
- Host: GitHub
- URL: https://github.com/software-mansion-labs/elixir-janus-plugin-videoroom
- Owner: software-mansion-labs
- License: apache-2.0
- Created: 2020-07-06T12:30:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-29T15:37:01.000Z (over 3 years ago)
- Last Synced: 2025-04-11T02:13:43.157Z (about 2 months ago)
- Language: Elixir
- Size: 115 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elixir Janus Plugin VideoRoom
This package implements functionality to communicate with [Janus VideoRoom plugin](https://janus.conf.meetecho.com/docs/videoroom.html).
It takes advantage of transport layer provided by another package [Elixir Janus](https://github.com/software-mansion-labs/elixir-janus).
## Disclaimer
Package is experimental and is not yet released to hex.
## Example
```elixir
# this example uses `Janus.Transport.WS` package for connection's transport and arbitrary `CustomHandler` module that implements `Janus.Handler` behaviour.
iex> alias Janus.{Connection, Session}
iex> alias Janus.Transport.WS
iex> alias Janus.Plugin.VideoRoom
iex> {:ok, connection} = Connection.start_link(WS, {"ws://gateway-domain:8188", WS.Adapters.WebSockex, []}, CustomHandler, {}, [])
iex> {:ok, session} = Session.start_link(connection)
iex> {:ok, room_id} = VideoRoom.create(session, "room id", %CreateRoomProperties{description: "test videoroom"}, "some admin key", "some room secret")
```
## Installation
```elixir
def deps do
[
{:elixir_janus_plugin_videoroom, github: "software-mansion-labs/elixir-janus-plugin-videoroom"}
]
end
```
## Testing
By default, the tests contacting Janus Gateway are disabled. To run them, use `mix test --include integration`
To run the instance for tests you can use Docker image:
```bash
docker run --rm -e GATEWAY_IP=127.0.0.1 -e WEBSOCKETS_ENABLED=true -e RTP_PORT_RANGE=10000-10099 -p 8188:8188 -p 10000-10099:10000-10099/udp -ti swmansion/janus-gateway:0.10.3-4
```
## Copyright and License
Copyright 2020, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=elixir-janus-plugin-videoroom)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=elixir-janus-plugin-videoroom)
Licensed under the [Apache License, Version 2.0](LICENSE)