Skip to content
This repository was archived by the owner on Feb 25, 2026. It is now read-only.
This repository was archived by the owner on Feb 25, 2026. It is now read-only.

Overview Section #91

Closed
Closed

Description

@Jayzon

When I first read the Overview Section (currently Section 1), I felt that the paragraph below would be easier to read if a vertical list format was used.

This specification defines several objects: RTCDtlsTransport (Section 2), RTCIceTransport (Section 3), RTCIceListener (Section 4), RTCRtpSender (Section 5), RTCRtpReceiver (Section 6), RTCRtpListener (Section 7), RTCDtmfSender (Section 9), RTCDataChannel (Section 10), and RTCSctpTransport (Section 11). RTP dictionaries are described in Section 8, and the Statistics API is described in Section 12.

Also, if the Sections (above) were links to their respective Sections (Section 2, Section 3, etc.) within the specification, it may be useful.


Regarding the graphic in the Overview, I was not able to determine which side was the sender or receiver until I noticed RTPSender and RTPReceiver within the graphic.

Would it be useful to show which sides are the Sender and Receiver?

Example, we could change the top left side of the graphic from "JavaScript App" to "JavaScript App (Sender)".


Furthermore, the object names in the graphic do not contain the RTC prefix.

While the object names within the graphic are more readable to me (like it is), should there be consistency with the object names?

Example, should RtpSender be changed to RTCRtpSender etc. ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions