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

Questions about chapters API #3895

Closed
hochhaus opened this issue Jan 22, 2022 · 4 comments
Closed

Questions about chapters API #3895

hochhaus opened this issue Jan 22, 2022 · 4 comments
Labels
status: archived Archived and locked; will not be updated type: question A question from the community

Comments

@hochhaus
Copy link
Contributor

Have you read the Tutorials?
Yes

Have you read the FAQ and checked for duplicate open issues?
Yes

What version of Shaka Player are you using?
v3.3.0

Please ask your question
I'm experimenting with the chapters API referencing the code, tests and comments (#3538 (comment)). Could you clarify my understanding of the following items?

  1. Why is the chapterURL provided via player.addChaptersTrack() instead of being included in the manifest? This isn't the end of the world but it seems unintuitive to me.
  2. Why does the addChaptersTrack() promise resolve before the chapters file has been downloaded and parsed by the browser? This seems to unnecessarily increase the complexity of correctly using chapters.
  3. Why does shaka.extern.Chapter not include the cue identifier (shaka.extern.Cue.id)? The calling code can pull this information directly out of the cue but it seems to unnecessarily complicate certain use cases.
@hochhaus hochhaus added the type: question A question from the community label Jan 22, 2022
@hochhaus
Copy link
Contributor Author

Why does the addChaptersTrack() promise resolve before the chapters file has been downloaded and parsed by the browser? This seems to unnecessarily increase the complexity of correctly using chapters.

To add a bit more context here, when shaka downloads a captions VTT file it appears to do so from a JS fetch(). However, when shaka downloads a chapters VTT file it appears to do so by appending a <track> element to the DOM. Possibly this is necessary for some reason. However, if it is not, possibly the API could be cleaned up by directly fetch()ing the chapters VTT as well?

@avelad
Copy link
Member

avelad commented May 3, 2022

Hi @hochhaus

  1. We would be happy to support it directly in HLS and DASH, but as far as I know it is not specified how they should be included, if you have the information, please open an enhancement issue so we can do it in the future.
  2. This sounds like a bug, please open a bug and we'll fix it.
  3. I think it can be easily fixed.

@hochhaus
Copy link
Contributor Author

hochhaus commented May 3, 2022

Thanks @avelad. I opened a dedicated issue per your comments so I will close this issue.

@hochhaus hochhaus closed this as completed May 3, 2022
@hochhaus
Copy link
Contributor Author

hochhaus commented May 3, 2022

We would be happy to support it directly in HLS and DASH, but as far as I know it is not specified how they should be included, if you have the information, please open an enhancement issue so we can do it in the future.

I also am not able to find this documented and the current implementation is not problematic. Should I find HLS / DASH documentation in the future I will open a dedicated issue.

@github-actions github-actions bot removed the status: waiting on response Waiting on a response from the reporter(s) of the issue label May 3, 2022
joeyparrish pushed a commit that referenced this issue May 3, 2022
@github-actions github-actions bot added the status: archived Archived and locked; will not be updated label Jul 2, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: archived Archived and locked; will not be updated type: question A question from the community
Projects
None yet
Development

No branches or pull requests

2 participants