document contentScale

TeamNewPipe · Oct 22, 2024 · c79ec3b · c79ec3b
1 parent 08af5af
commit c79ec3b
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/new-player/src/main/java/net/newpipe/newplayer/ui/ContentScale.kt b/new-player/src/main/java/net/newpipe/newplayer/ui/ContentScale.kt
@@ -20,8 +20,25 @@
 
 package net.newpipe.newplayer.ui
 
+/**
+ * Depicts how the video should be layout in fullscreen mode.
+ */
 enum class ContentScale {
-    FILL,
+    /**
+     * The video will fill the entire screen but it will also be stretched.
+     */
+    STRETCHED,
+
+    /**
+     * The video will fit fully inside the screen's view pod, and will align with at least two
+     * opposing borders.
+     */
     FIT_INSIDE,
+
+    /**
+     * The video will fill the entire screen. The aspect ratio of the video will remain true,
+     * but parts of the video will be cropped of. However, the video will align with at least
+     * two opposing borders, so that as little as possible video content is cropped of.
+     */
     CROP
 }