Skip to content

Improve JavaDoc for StreamPlayerListener.progress #35

@HelgeStenstrom

Description

@HelgeStenstrom

* 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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    improvementRefactorings and internal structure improvements

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions