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.

Sign up for GitHub

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

Jump to bottom

Documenting its behaviour better #120

Open

mkitti opened this issue Aug 5, 2022 · 0 comments

Assignees

Member

mkitti commented Aug 5, 2022 •

edited

Loading

A good start is documenting its behaviour better - what is the buffer growth behaviour? How does one stop a transcoding? What is the "mark" in the buffer and how does one set and clear it?

I think documenting all supported behaviours is a good starting point for thinking about the API. For example, the way to stop a transcoding is to write a TOKEN_END to a stream. The obscurity of that suggests perhaps that should be a method instead

mkitti self-assigned this

mkitti changed the title ~~To do note~~ Documenting its behaviour better

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment