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

API documentation? #605

Open
Yahav opened this issue Feb 10, 2022 · 3 comments
Open

API documentation? #605

Yahav opened this issue Feb 10, 2022 · 3 comments

Comments

@Yahav
Copy link

Yahav commented Feb 10, 2022

Is there any documentation for the library api? eg. play()/pause()/events/errors etc?
Or is it "binding" with the audio API?

@bvibber
Copy link
Owner

bvibber commented Feb 10, 2022

OGVPlayer implements a subset of the HTMLVideoElement API, however it is not entirely complete. There's not thorough documentation at this time, so if in doubt check the source code. :)

@UlyssesZh
Copy link

I would really appreciate that if there is a thorough API documentation.

Right now I want to find a way to use ogv.js to decode the ArrayBuffer of an OGG file into an AudioBuffer, but there is no API documentation, so I have to search through the source codes.

@bvibber
Copy link
Owner

bvibber commented Jul 22, 2023

There's not a convenient or stable API for that (the only stable API is the HTMLMediaElement API, and it's incomplete). Good luck with your project!

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