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

Improve JavaDoc for StreamPlayerListener.progress #35

Open
HelgeStenstrom opened this issue Sep 7, 2019 · 4 comments
Open

Improve JavaDoc for StreamPlayerListener.progress #35

HelgeStenstrom opened this issue Sep 7, 2019 · 4 comments
Labels
improvement Refactorings and internal structure improvements

Comments

@HelgeStenstrom
Copy link
Collaborator

* Is called several times per second when StreamPlayer run method is
* running.
*
* @param nEncodedBytes the n encoded bytes
* @param microsecondPosition the microsecond position
* @param pcmData the pcm data
* @param properties the properties

Try to answer at least these questions:

  • When and how often is progress() called? Who is the caller?
  • Clarify nEncodedBytes the n encoded bytes. Does it mean "the number of encoded bytes"? If so, since when? Where are these bytes and where do they come from?
  • microsecondPosition the microsecond position: When does the timer start? How often is the value updated? For each call of progress()?
  • Is there any guarantee for how it is encoded? If so, how is the pcmData encoded? Apparently it's an array of bytes. How does it encode two or more channels of 16 or more bits per sample?
  • What are the properties?
@HelgeStenstrom HelgeStenstrom added the improvement Refactorings and internal structure improvements label Sep 7, 2019
@goxr3plus
Copy link
Owner

goxr3plus commented Sep 8, 2019

*THe encoded bytes are the bytes that have been encoded since the start of audio it's actually how many bytes have totally been read from the file.

@goxr3plus
Copy link
Owner

Properties have been there for some reason i think they are used for audio filtering and getting information about the current audio file.

For the others questions i have read the code :)

@goxr3plus
Copy link
Owner

I am not quite sure about the microsecond position, it's actually what it says i think.

1 similar comment
@goxr3plus
Copy link
Owner

I am not quite sure about the microsecond position, it's actually what it says i think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Refactorings and internal structure improvements
Projects
None yet
Development

No branches or pull requests

2 participants