RE: Overview section discussion

Filed as issue 87.
________________________________________
From: Jason Ausborn [jason.ausborn@gmail.com]
Sent: Friday, May 16, 2014 2:39 AM
To: public-ortc@w3.org
Subject: Overview section discussion

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. ?


HTH,

Jason

Received on Friday, 16 May 2014 17:33:44 UTC