Skip to content

Commit e9dced0

Browse files
committed
Improve docs
1 parent 60a828c commit e9dced0

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

lib/ex_webrtc/rtp/vp8_depayloader.ex

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
defmodule ExWebRTC.RTP.VP8Depayloader do
22
@moduledoc """
33
Reassembles VP8 frames from RTP packets.
4+
5+
Based on [RFC 7741: RTP Payload Format for VP8 Video](https://datatracker.ietf.org/doc/html/rfc7741)
46
"""
57
require Logger
68

lib/ex_webrtc/rtp/vp8_payload.ex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
defmodule ExWebRTC.RTP.VP8Payload do
22
@moduledoc """
33
Defines VP8 payload structure stored in RTP packet payload.
4+
5+
Based on [RFC 7741: RTP Payload Format for VP8 Video](https://datatracker.ietf.org/doc/html/rfc7741)
46
"""
57

68
@type t() :: %__MODULE__{
@@ -82,7 +84,8 @@ defmodule ExWebRTC.RTP.VP8Payload do
8284
do: {:ok, tid, y, nil, rest}
8385

8486
# note that both pion and web browser always set y bit to 0 in this case
85-
# but RFC explicitly states that y bit can be set when t is 0 and k is 1
87+
# but RFC 7741, sec. 4.2 (definition for Y bit) explicitly states that Y bit
88+
# can be set when T is 0 and K is 1
8689
defp parse_tidykeyidx(0, 1, <<_tid::2, y::1, keyidx::5, rest::binary>>),
8790
do: {:ok, nil, y, keyidx, rest}
8891

lib/ex_webrtc/rtp/vp8_payloader.ex

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ defmodule ExWebRTC.RTP.VP8Payloader do
22
@moduledoc """
33
Encapsulates VP8 video frames into RTP packets.
44
5+
Based on [RFC 7741: RTP Payload Format for VP8 Video](https://datatracker.ietf.org/doc/html/rfc7741)
6+
57
It does not support `X` bit right now, in particular it
68
does not pay attention to VP8 partion boundaries (see RFC 7741 sec. 4.4).
79
"""

0 commit comments

Comments
 (0)