https://github.com/elixir-webrtc/live_ex_webrtc
Phoenix Live Components for Elixir WebRTC
https://github.com/elixir-webrtc/live_ex_webrtc
audio elixir phoenix-framework phoenix-liveview video webrtc
Last synced: about 1 year ago
JSON representation
Phoenix Live Components for Elixir WebRTC
- Host: GitHub
- URL: https://github.com/elixir-webrtc/live_ex_webrtc
- Owner: elixir-webrtc
- License: apache-2.0
- Created: 2024-09-08T08:51:04.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-10T10:23:43.000Z (about 1 year ago)
- Last Synced: 2025-03-10T11:27:32.531Z (about 1 year ago)
- Topics: audio, elixir, phoenix-framework, phoenix-liveview, video, webrtc
- Language: Elixir
- Homepage: https://elixir-webrtc.org
- Size: 106 KB
- Stars: 33
- Watchers: 0
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LiveExWebRTC
[](https://hex.pm/packages/live_ex_webrtc)
[](https://hexdocs.pm/live_ex_webrtc)
Phoenix Live Components for [Elixir WebRTC](https://github.com/elixir-webrtc/ex_webrtc).
## Installation
In your `mix.exs`:
```elixir
def deps do
[
{:live_ex_webrtc, "~> 0.6.0"}
]
end
```
In your `tailwind.config.js`
```js
module.exports = {
content: [
"../deps/live_ex_webrtc/**/*.*ex" // ADD THIS LINE
]
}
```
## Usage
`LiveExWebRTC` comes with two `Phoenix.LiveView`s:
* `LiveExWebRTC.Publisher` - sends audio and video via WebRTC from a web browser to a Phoenix app (browser publishes)
* `LiveExWebRTC.Player` - sends audio and video via WebRTC from a Phoenix app to a web browser and plays it in the HTMLVideoElement (browser subscribes)
See module docs and [live_broadcaster](https://github.com/elixir-webrtc/live_broadcaster) for more.
## Local development
For local development:
* include `live_ex_webrtc` in your `mix.exs` via `path`
* modify `NODE_PATH` env variable in your esbuild configuration, which is located in `config.exs` - this will allow for importing javascript hooks from `live_ex_webrtc`.
For example:
```elixir
config :esbuild,
# ...
default: [
# ...
env: %{
"NODE_PATH" => "#{Path.expand("../deps", __DIR__)}:/path/to/parent/dir/of/live_ex_webrtc"
}
]
```
* modify `content` in `tailwind.config.js` - this will compile tailwind classes used in live components.
For example:
```js
module.exports = {
content: [
// ...
"../deps/**/*.ex"
]
}
```
> #### Important {: .info}
> Separate paths with `:` on MacOS/Linux and with `;` on Windows.
> #### Important {: .info}
> Specify path to live_ex_webrtc's parent directory.