Improve the structs in the API, add docs #104
Conversation
lib/ex_webrtc/peer_connection.ex
Outdated
| """ | ||
| @type signaling_state() :: :stable | :have_local_offer | :have_remote_offer | ||
|
|
||
| @typedoc """ | ||
| Possible PeerConnection states. | ||
| Messages sent by the the `ExWebRTC.PeerConnection` process to its controlling process. |
There was a problem hiding this comment.
| Messages sent by the the `ExWebRTC.PeerConnection` process to its controlling process. | |
| Messages sent by the `ExWebRTC.PeerConnection` process to its controlling process. |
lib/ex_webrtc/peer_connection.ex
Outdated
| ) :: {:ok, RTPTransceiver.t()} | ||
| def add_transceiver(peer_connection, kind_or_track, options \\ []) do | ||
| GenServer.call(peer_connection, {:add_transceiver, kind_or_track, options}) | ||
| end | ||
|
|
||
| @doc """ | ||
| Sets the direction of transceiver specified by the `id`. |
There was a problem hiding this comment.
Take a look at other functions too
| Sets the direction of transceiver specified by the `id`. | |
| Sets the direction of transceiver specified by the `transceiver_id`. |
lib/ex_webrtc/peer_connection.ex
Outdated
|
|
||
| See [RTCStatsReport](https://www.w3.org/TR/webrtc/#rtcstatsreport-object) for the output structure. | ||
| This function kills the PeerConnection process. |
There was a problem hiding this comment.
| This function kills the PeerConnection process. | |
| This function kills the `ExWebRTC.PeerConnection` process. |
| Records incoming RTP Packet. | ||
| `time` parameter accepts output of `System.monotonic_time()` as a value. | ||
| """ | ||
| # `time` parameter accepts output of `System.monotonic_time()` as a value. |
There was a problem hiding this comment.
IMO the previous docs could stay
There was a problem hiding this comment.
I'd say to leave as a comment and in general use comments for developer information and docs for public stuff? The only useful thing I could think off was that the LSP would provide the doc info even when function is private, but it doesn't seem to be the case.
EDIT: nvm, LSP does provide this info (which is actually useful), so I'll leave it as a doc.
| This function can be called only if at least one packet has been recorded, | ||
| otherwise it will raise. | ||
| """ | ||
| # `time` parameter accepts output of `System.os_time(:native)` as a value (UNIX timestamp in :native units). |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #104 +/- ##
==========================================
- Coverage 87.20% 86.46% -0.75%
==========================================
Files 33 33
Lines 1626 1655 +29
==========================================
+ Hits 1418 1431 +13
- Misses 208 224 +16
Continue to review full report in Codecov by Sentry.
|
This PR:
RTPTransceiver,RTPSenderandRTPReceiverstructs (like the "recorder..." modules)PeerConnection(for the various states)