From 542867ff4d5043d803d95d83ba14ff7fb7d3fff0 Mon Sep 17 00:00:00 2001
From: Thompson3142 <115718208+Thompson3142@users.noreply.github.com>
Date: Thu, 24 Oct 2024 19:36:35 +0200
Subject: [PATCH] Add documentation for faulty framesets

---
 .../services/youtube/extractors/YoutubeStreamExtractor.java  | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
index e6fb7c1b4..9623baea1 100644
--- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
+++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
@@ -1377,6 +1377,11 @@ public class YoutubeStreamExtractor extends StreamExtractor {
         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
     @Nonnull
     @Override
     public List<Frameset> getFrames() throws ExtractionException {