Skip to content

Commit

Permalink
Use JDoc and inherit doc
Browse files Browse the repository at this point in the history
  • Loading branch information
TobiGr committed Oct 27, 2024
1 parent 542867f commit cbe30b8
Showing 1 changed file with 12 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1377,11 +1377,18 @@ private ItagInfo buildAndAddItagInfoToList(
return itagInfo;
}

// Warning: When using this method be aware that the YouTube API very rarely returns framesets,
// that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains
// a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this
// "manually" to avoid errors.
// For further reference see: https://github.com/TeamNewPipe/NewPipe/pull/11596

/**
* {@inheritDoc}
* Should return a list of Frameset object that contains preview of stream frames
*
* <p><b>Warning:</b> When using this method be aware that the YouTube API very rarely returns framesets,
* that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains
* a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this
* "manually" to avoid errors.</p>
*
* @see <a href="https://github.com/TeamNewPipe/NewPipe/pull/11596">TeamNewPipe/NewPipe#11596</a>
*/
@Nonnull
@Override
public List<Frameset> getFrames() throws ExtractionException {
Expand Down

0 comments on commit cbe30b8

Please sign in to comment.