Skip to content

Commit

Permalink
Update attributes docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FelonEkonom committed Mar 4, 2025
1 parent bc136cd commit af61686
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions lib/membrane_webrtc_live/capture.ex
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ defmodule Membrane.WebRTC.Live.Capture do
@impl true
def render(assigns) do
~H"""
<Capture.live_render socket={@socket} capture={"capture"} />
<Capture.live_render socket={@socket} capture_id={"capture"} />
"""
end
Expand Down Expand Up @@ -64,9 +64,8 @@ defmodule Membrane.WebRTC.Live.Capture do
attr(:capture_id, :string,
required: true,
doc: """
#{inspect(__MODULE__)} struct. It is used to pass capture id to the newly created live view via live view session.
This data is then used to do a handshake between parent live view and child live view during which child live view
receives the whole #{inspect(__MODULE__)} struct.
ID of a `caputre` previously attached to the socket. It has to be the same as the value passed to `:id`
field `#{inspect(__MODULE__)}.attach/2`.
"""
)

Expand Down
7 changes: 3 additions & 4 deletions lib/membrane_webrtc_live/player.ex
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ defmodule Membrane.WebRTC.Live.Player do
@impl true
def render(assigns) do
~H"""
<Player.live_render socket={@socket} player={"player"} />
<Player.live_render socket={@socket} player_id={"player"} />
"""
end
Expand Down Expand Up @@ -65,9 +65,8 @@ defmodule Membrane.WebRTC.Live.Player do
attr(:player_id, :string,
required: true,
doc: """
#{inspect(__MODULE__)} struct. It is used to pass player id to the newly created live view via live view session.
This data is then used to do a handshake between parent live view and child live view during which child live view
receives the whole #{inspect(__MODULE__)} struct.
ID of a `player` previously attached to the socket. It has to be the same as the value passed to `:id`
field `#{inspect(__MODULE__)}.attach/2`.
"""
)

Expand Down

0 comments on commit af61686

Please sign in to comment.