Skip to content

Commit 9bd8888

Browse files
mickel8mickel8
committed
Release v0.1.0
1 parent a50882c commit 9bd8888

File tree

6 files changed

+409
-46
lines changed

6 files changed

+409
-46
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2024 Elixir WebRTC Developers
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# LiveExWebrtc
1+
# LiveExWebRTC
22

3-
**WIP**
3+
[![Hex.pm](https://img.shields.io/hexpm/v/live_ex_webrtc.svg)](https://hex.pm/packages/live_ex_webrtc)
4+
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/live_ex_webrtc)
45

56
Phoenix Live Components for Elixir WebRTC.
67

78
## Installation
89

10+
In your `mix.exs`:
11+
912
```elixir
1013
def deps do
1114
[
@@ -14,45 +17,23 @@ def deps do
1417
end
1518
```
1619

17-
## Usage
18-
19-
1. Add LiveExWebRTCPlayer hook to the list of your Phoenix Live View hooks:
20+
In your `tailwind.config.js`
2021

2122
```js
22-
import { LiveExWebRTCPlayer } from "live_ex_webrtc";
23-
let Hooks = {};
24-
Hooks.LiveExWebRTCPlayer = LiveExWebRTCPlayer;
25-
let liveSocket = new LiveSocket("live", Socket, { hooks: Hooks });
23+
module.exports = {
24+
content: [
25+
"../deps/live_ex_webrtc/**/*.*ex" // ADD THIS LINE
26+
]
27+
}
2628
```
2729

28-
2. Use LiveExWebRTC.Player component in your LiveView:
29-
30-
```ex
31-
defmodule MyLiveView do
32-
use Phoenix.LiveView
33-
34-
alias ExWebRTC.RTPCodecParameters
35-
36-
@video_codecs [
37-
%RTPCodecParameters{
38-
payload_type: 96,
39-
mime_type: "video/VP8",
40-
clock_rate: 90_000
41-
}
42-
]
30+
## Usage
4331

44-
def mount(_params, _session, socket) do
45-
socket = assign(socket, video_codecs: @video_codecs)
46-
{:ok, socket}
47-
end
32+
`LiveExWebRTC` comes with two `Phoenix.LiveComponent`s:
33+
* `LiveExWebRTC.Publisher` - sends audio and video via WebRTC from a web browser to a Phoenix app (browser publishes)
34+
* `LiveExWebRTC.Subscriber` - sends audio and video via WebRTC from a Phoenix app to a web browser (browser subscribes)
4835

49-
def render(assigns) do
50-
~H"""
51-
<.live_component module={LiveExWebRTC.Player} id="player" video_codecs={@video_codecs} />
52-
"""
53-
end
54-
end
55-
```
36+
See module docs for more.
5637

5738
## Local development
5839

@@ -86,8 +67,8 @@ For local development:
8667
}
8768
```
8869

89-
> [!IMPORTANT]
70+
> #### Important {: .info}
9071
> Separate paths with `:` on MacOS/Linux and with `;` on Windows.
9172
92-
> [!IMPORTANT]
73+
> #### Important {: .info}
9374
> Specify path to live_ex_webrtc's parent directory.

‎lib/live_ex_webrtc/publisher.ex

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,74 @@
11
defmodule LiveExWebRTC.Publisher do
2+
@moduledoc """
3+
`Phoenix.LiveComponent` for sending audio and video via WebRTC from a browser to a Phoenix app (browser publishes).
4+
5+
It will render a view with:
6+
* audio and video device selects
7+
* audio and video stream configs
8+
* stream preview
9+
* transmission stats
10+
11+
Once rendered, your `Phoenix.LiveView` will receive `t:init_msg/0` and will start getting
12+
RTP audio and video packets that can be forwarded to other clients.
13+
14+
Publisher always negotiates a single audio and video track.
15+
16+
## Assigns
17+
18+
* `ice_servers` - a list of `t:ExWebRTC.PeerConnection.Configuration.ice_server/0`,
19+
* `ice_ip_filter` - `t:ExICE.ICEAgent.ip_filter/0`,
20+
* `ice_port_range` - `t:Enumerable.t(non_neg_integer())/1`,
21+
* `audio_codecs` - a list of `t:ExWebRTC.RTPCodecParameters.t/0`,
22+
* `video_codecs` - a list of `t:ExWebRTC.RTPCodecParameters.t/0`,
23+
* `gen_server_name` - `t:GenServer.name/0`
24+
25+
## JavaScript Hook
26+
27+
Publisher live component requires JavaScript hook to be registered under `Publisher` name.
28+
The hook can be created using `createPublisherHook` function.
29+
For example:
30+
31+
```javascript
32+
import { createPublisherHook } from "live_ex_webrtc";
33+
let Hooks = {};
34+
const iceServers = [{ urls: "stun:stun.l.google.com:19302" }];
35+
Hooks.Publisher = createPublisherHook(iceServers);
36+
let liveSocket = new LiveSocket("/live", Socket, {
37+
// ...
38+
hooks: Hooks
39+
});
40+
```
41+
42+
## Examples
43+
44+
```elixir
45+
<.live_component
46+
module={LiveExWebRTC.Publisher}
47+
id="publisher"
48+
ice_servers={[%{urls: "stun:stun.l.google.com:19302"}]}
49+
/>
50+
```
51+
"""
252
use Phoenix.LiveComponent
353

4-
alias ExWebRTC.{PeerConnection, SessionDescription}
54+
alias ExWebRTC.{ICECandidate, PeerConnection, SessionDescription}
55+
56+
@typedoc """
57+
Message sent to the `Phoenix.LiveView` after component's initialization.
58+
59+
* `pc` - `ExWebRTC.PeerConnection`'s pid spawned by this live component
60+
* `audio_track_id` - id of audio track
61+
* `video_track_id` - id of video track
62+
"""
63+
@type init_msg() ::
64+
{:live_ex_webrtc,
65+
%{
66+
pc: pid(),
67+
audio_track_id: String.t(),
68+
video_track_id: String.t()
69+
}}
570

71+
@impl true
672
def render(assigns) do
773
~H"""
874
<div id={@id} phx-hook="Publisher" class="h-full w-full flex justify-between gap-6">
@@ -128,10 +194,12 @@ defmodule LiveExWebRTC.Publisher do
128194
"""
129195
end
130196

197+
@impl true
131198
def handle_event(_event, _unsigned_params, %{assigns: %{pc: nil}} = socket) do
132199
{:noreply, socket}
133200
end
134201

202+
@impl true
135203
def handle_event("offer", unsigned_params, socket) do
136204
offer = SessionDescription.from_json(unsigned_params)
137205
{:ok, pc} = spawn_peer_connection(socket)
@@ -157,11 +225,13 @@ defmodule LiveExWebRTC.Publisher do
157225
{:noreply, socket}
158226
end
159227

228+
@impl true
160229
def handle_event("ice", "null", socket) do
161-
:ok = PeerConnection.add_ice_candidate(socket.assigns.pc, %{candidate: ""})
230+
:ok = PeerConnection.add_ice_candidate(socket.assigns.pc, %ICECandidate{candidate: ""})
162231
{:noreply, socket}
163232
end
164233

234+
@impl true
165235
def handle_event("ice", unsigned_params, socket) do
166236
cand =
167237
unsigned_params

0 commit comments

Comments
 (0)