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

Better documentation #1087

Closed
pculka opened this issue Mar 14, 2014 · 3 comments
Closed

Better documentation #1087

pculka opened this issue Mar 14, 2014 · 3 comments

Comments

@pculka
Copy link

pculka commented Mar 14, 2014

Please. Make the documentation readable and more comprehensible. I try to find how to check if the video is playing or not for 1 Hour.
The only thing you state in the docs is, that it adheres to HTML5 API standard.

How do I acces the MediaControllerPlaybackState enum then??

@gkatsev
Copy link
Member

gkatsev commented Mar 14, 2014

I think the docs have greatly improved from where they were a while ago.
Anyway, to check if the player is playing or paused, just use player.paused().

@mmcc
Copy link
Member

mmcc commented Mar 14, 2014

I'm going to close this one, but I would still very much like to hear how we could have improved things for you @pculka. I would think that the player API docs would be one of the first places you would look for a function like this, but we obviously didn't do a good job funneling you there through the guides and such. What would have helped?

At the end of the day, great documentation is hard. :) Thank you for the help! When you see things that could be improved, don't hesitate to submit a PR.

@mmcc mmcc closed this as completed Mar 14, 2014
@pculka
Copy link
Author

pculka commented Mar 28, 2014

Hi, thanks!
I found another way:
@gkatsev I needed an event callback after the event was triggered. I don't really want to do setInterval for 1 ms and check if the video has ended or not ... That's like the year 1998

video.on("event", function(callback){}) - worked like a charm

@mmcc:
The crazyness how all the tiny little things are fragmented is difficult to search through. Sometimes the readers aren't always on the same "thinkwave" as the developers, meaning I have no clue in which little fragment should I search for the things I want. Having most of the "global" themes on one page is a way to improve on the docs. Also, beacuse it is such a big project, a .pdf (searchable one) would be amazing to have. Also, can you please link me the documentation, where is the video.on("xxx", callback) documented?

For example I search now how can I bind MORE events in one line - and there is NO EXAMPLE or anything at least hinting HOW to do. So I serialized 3x .on statements with the same three blocks. That's like a "WTF" solution (works though).

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

No branches or pull requests

3 participants