WebIDL Types #88

Closed
aboba opened this Issue May 16, 2014 · 5 comments

Projects

None yet

3 participants

@aboba
Contributor
aboba commented May 16, 2014

From: Jason Ausborn jason.ausborn@gmail.com
Date: Fri, 16 May 2014 02:22:15 -0500
To: public-ortc@w3.org
URL: http://lists.w3.org/Archives/Public/public-ortc/2014May/0108.html

I believe that the WebIDL Type of "unsigned int" should be changed to
either unsigned short, unsigned long, or unsigned long long. Reason being,
the "int" Type is not listed as a Type for WebIDL (from my understanding).

Areas are highlighted yellow below:

8.1 RTCRtpUnhandled

dictionary RTCRtpUnhandled {
unsigned int
ssrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-ssrc
;
unsigned byte
payloadTypehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-payloadType
;
DOMString? receiverIdhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-receiverId
;
};

8.3 dictionary RTCRtpCodec

dictionary RTCRtpCodec {
DOMString namehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-name=
"";
unsigned int?
hzRatehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-hzRate=
null;
unsigned byte
preferredPayloadTypehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-preferredPayloadType
;
unsigned int?
numChannelshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-numChannels=
1;
Capabilities
formatshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-formats
;
};

8.4 dictionary RTCRtpParameters

dictionary RTCRtpParameters {
DOMString receiverIdhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpParameters-receiverId=
"";
sequence<_RTCRtpCodecParameters_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpCodecParameters

codecshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpParameters-codecs
;
sequence<_RTCRtpHeaderExtensionParameters_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpHeaderExtensionParameters
headerExtensionshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpParameters-headerExtensions
;
sequence<_RTCRtpEncodingParameters_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpEncodingParameters
encodingshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpParameters-encodings
;
unsigned int
rtcpSsrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpParameters-rtcpSsrc
;
};

8.6 dictionary RTCRtpEncodingParameters

dictionary RTCRtpEncodingParameters {
unsigned int?
ssrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-ssrc=
null;
DOMString codecNamehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-codecName=
"";
_RTCRtpFecParameters_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpFecParameters
? fechttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-fec=
null;
_RTCRtpRtxParameters_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpRtxParameters
? rtxhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-rtx=
null;
double priorityhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-priority=
1.0;
double? maxBitratehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-maxBitrate=
null;
double minQualityhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-minQuality=
0;
double frameratebiashttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-frameratebias=
0.5;
double scalehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-scale=
null;
double frameratehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-framerate=
null;
double qualityhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-quality=
null;
boolean activehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-active=
true;
DOMString? encodingIdhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-encodingId
;
sequence
dependencyEncodingIdshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpEncodingParameters-dependencyEncodingIds
;
};

8.8 dictionary RTCRtpFecParameters

dictionary RTCRtpFecParameters {
unsigned int?
ssrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpFecParameters-ssrc=
null;
DOMString mechanismhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpFecParameters-mechanism
;
};

8.9 dictionary RTCRtpRtxParameters

dictionary RTCRtpRtxParameters {
unsigned int?
ssrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpRtxParameters-ssrc=
null;
};

11.3.3 dictionary RTCSctpCapabilities

dictionary RTCSctpCapabilities {
unsigned int
maxMessageSizehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCSctpCapabilities-maxMessageSize=
null;
};


Also, I did not find an "unsigned byte" type for WebIDL (from my
understanding)

Areas are highlighted yellow below:

8.1 RTCRtpUnhandled

dictionary RTCRtpUnhandled {
unsigned int
ssrchttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-ssrc
;
unsigned byte
payloadTypehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-payloadType
;
DOMString? receiverIdhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpUnhandled-receiverId
;
};

8.3 dictionary RTCRtpCodec

dictionary RTCRtpCodec {
DOMString namehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-name=
"";
unsigned int?
hzRatehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-hzRate=
null;
unsigned byte
preferredPayloadTypehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-preferredPayloadType
;
unsigned int?
numChannelshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-numChannels=
1;
Capabilities
formatshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodec-formats
;
};

8.5 dictionary RTCRtpCodecParameters

dictionary RTCRtpCodecParameters {
unsigned byte
payloadTypehttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodecParameters-payloadType
;
_RTCRtpCodec_http://ortc.org/wp-content/uploads/2014/05/ortc.html#idl-def-RTCRtpCodec
codechttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodecParameters-codec
;
Settings formatshttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodecParameters-formats
;
Settings rtcpFeedbackhttp://ortc.org/wp-content/uploads/2014/05/ortc.html#widl-RTCRtpCodecParameters-rtcpFeedback
;
};


HTH,

Jason

@Jayzon
Jayzon commented May 16, 2014

Thanks for posting this for me aboba. This issue can be closed because I duplicated this message across Issue #89 and Issue #90.

BTW, sorry for sending the issues to the email group. From now on, I will put issues here accordingly.

@robin-raymond
Contributor

Actually, you did the right thing originally. Please post issues on the group email list. The editors are using github to track issues for changes that need to be made to the specification but the group is where people bring issues to our attention in the first place.

@robin-raymond
Contributor

FYI - There are IPR issues as to why we ask people to post via the group.

@Jayzon
Jayzon commented May 16, 2014

Thanks for clarifying that for me.

@aboba
Contributor
aboba commented May 22, 2014

Some additional WebIDL issues from Jason Ausborn:

Issue:

I believe the order is incorrect below.


9.11.1 PropertyValueSet

typedef PropertyValueSet DOMString[];


Recommended changes below:


9.11.1 PropertyValueSet

typedef DOMString[] PropertyValueSet;


Issue:

I believe the order is incorrect below.


9.11.2 MutliPropertyValueSet

typedef MultiPropertyValueSet DOMString[];


Recommended changes below:


9.11.2 MutliPropertyValueSet

typedef DOMString[] MultiPropertyValueSet;


Issue:

I believe that "object" is a reserved keyword, and it cannot be used as a Parameter name.
(shown below)


  1. Statistics API

interface RTCStats {

void getStats (RTCStatsObject object, RTCStatsCallback successCallback, RTCErrorCallback failureCallback);

};


Recommended changes below:

(Note, the stats name can be anything not reserved)


  1. Statistics API

interface RTCStats {

void getStats (RTCStatsObject stats, RTCStatsCallback successCallback, RTCErrorCallback failureCallback);

};

Issue:

I believe that there is a syntax issue below.

(boolean isRemote default false;)


13.6.1 RTCRtpStreamStats

dictionary RTCRTPStreamStats : RTCStats {
DOMString ssrc;
DOMString remoteId;
boolean isRemote default false;
DOMString mediaTrackId;
DOMString transportId;
DOMString codecId;
unsigned long firCount;
unsigned long pliCount;
unsigned long nackCount;
unsigned long sliCount;
};


Recommended changes below:

(boolean isRemote = false;)


13.6.1 RTCRtpStreamStats

dictionary RTCRTPStreamStats : RTCStats {
DOMString ssrc;
DOMString remoteId;
boolean isRemote = false;
DOMString mediaTrackId;
DOMString transportId;
DOMString codecId;
unsigned long firCount;
unsigned long pliCount;
unsigned long nackCount;
unsigned long sliCount;
};

@aboba aboba closed this May 29, 2014
@robin-raymond robin-raymond pushed a commit to robin-raymond/ortc that referenced this issue Jun 15, 2014
Robin Raymond - Added support for non-multiplexed RTP/RTCP and ICE freezing, as des…
…cribed in Issue 57


w3c#57

- Added support for getRemoteCertificates(), as described in Issue 67
w3c#67

- Removed filterParameters and createParameters functions, as described in Issue 80
w3c#80

- Partially addressed capabilities issues, as described in Issue 84
w3c#84

Addressed WebIDL type issues described in Issue 88
w3c#88

- Addressed Overview section issues described in Issue 91
w3c#91

- Address readonly attribute issues described in Issue 92
w3c#92

- Added ICE restart method to address the issue described in Issue 93
w3c#93

- Added onerror eventhandler to sender and receiver objects as described in Issue 95
w3c#95
f74b889
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment