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.

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

[YouTube] Add documentation for faulty framesets #1236

Merged
merged 2 commits into from
Oct 27, 2024
Merged

[YouTube] Add documentation for faulty framesets #1236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
542867f
Add documentation for faulty framesets
Thompson3142 Oct 24, 2024
1f26c12
Use JDoc and inherit doc
TobiGr Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ...java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1377,6 +1377,20 @@ private ItagInfo buildAndAddItagInfoToList(
return itagInfo;
}


/**
* {@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
Loading