Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

declarations in section 6.5.1 (20170316 version) are wrong #50

Closed
paulhiggs opened this issue Mar 19, 2017 · 5 comments
Closed

declarations in section 6.5.1 (20170316 version) are wrong #50

paulhiggs opened this issue Mar 19, 2017 · 5 comments

Comments

@paulhiggs
Copy link

In section 6.5.1 (https://www.w3.org/TR/tvcontrol-api/#dictionary-tvsourcesupportedconstraints-members) the members are defined as boolean with default value of "true"

Same for section 6.7.1 (https://www.w3.org/TR/tvcontrol-api/#dictionary-tvsourceconstraints-members)

@tidoust
Copy link
Member

tidoust commented Mar 20, 2017

Section 6.7.1 is indeed incorrect. The IDL definition in 6.7 is correct but the prose is wrong.

I believe section 6.5.1 is correct though: the TVSourceSupportedConstraints dictionary lists the constraints recognized by a user agent. All members are boolean, as expected. This is similar to the MediaTrackSupportedConstraints interface from Media Capture and Streams.

I'll create another issue for TVSourceSupportedConstraints as we seem to have lost ourselves in the constraint pattern in the current spec: TVSourceSupportedConstraints is not referenced anywhere.

@paulhiggs
Copy link
Author

Perhaps we need some other terms then..
6.5.1 says

6.5.1 Dictionary TVSourceSupportedConstraints Members
deliverySystem of type boolean defaulting to true
See deliverySystem for details.
height of type boolean defaulting to true
See height for details.
channel of type boolean defaulting to true
See channel for details.
tuningStep of type boolean defaulting to true
See tuningStep for details.

Looking at tuningStep in 6.6 it is defined as a long and clicking on it takes me to a definition in 6.9 where it is defined as a ConstrainLong. No boolean in sight there!
Looks to be the same when clicking on height and channel in 6.5.1.

@tidoust
Copy link
Member

tidoust commented Mar 21, 2017

This follows the same pattern as in the Media Capture and Streams spec, but that's indeed unclear. Goal is to link to the description of the meaning of each constraint, not to their type.

We could perhaps replace "See deliverySystem for details" (and other similar sentences) by "Whether the deliverySystem constraint is supported".

@stevem-tw
Copy link
Contributor

I've hopefully fixed both issues (the suggested rewording and correcting the types in 6.7) in the latest editor's draft. Section 6.5.1 is correct, although it's easy to understand the confusion. having fixes some of the other related issues, this area should now be a little clearer.

@paulhiggs
Copy link
Author

Seems to be dead...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants