Allow setting KeepScreenOn window flag

Author: G00fY2

README.md

@@ -116,6 +116,7 @@ override fun onCreate(savedInstanceState: Bundle?) {
           setShowCloseButton(true) // show or hide (default) close button
           setHorizontalFrameRatio(2.2f) // set the horizontal overlay ratio (default is 1 / square frame)
           setUseFrontCamera(true) // use the front camera
+          setKeepScreenOn(true) // keep the device's screen turned on
         }
       )
     }

quickie/src/main/kotlin/io/github/g00fy2/quickie/QRScannerActivity.kt

@@ -10,6 +10,7 @@ import android.util.Size
 import android.view.HapticFeedbackConstants
 import android.view.KeyEvent
 import android.view.View
+import android.view.WindowManager
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.view.ContextThemeWrapper
@@ -195,6 +196,8 @@ internal class QRScannerActivity : AppCompatActivity() {
       showTorchToggle = it.showTorchToggle
       useFrontCamera = it.useFrontCamera
       showCloseButton = it.showCloseButton
+
+      if (it.keepScreenOn) window.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON)
     }
   }
 

quickie/src/main/kotlin/io/github/g00fy2/quickie/config/ParcelableScannerConfig.kt

@@ -13,4 +13,5 @@ internal class ParcelableScannerConfig(
   val horizontalFrameRatio: Float,
   val useFrontCamera: Boolean,
   val showCloseButton: Boolean,
+  val keepScreenOn: Boolean,
 ) : Parcelable

quickie/src/main/kotlin/io/github/g00fy2/quickie/config/ScannerConfig.kt

@@ -16,6 +16,7 @@ public class ScannerConfig internal constructor(
   internal val horizontalFrameRatio: Float,
   internal val useFrontCamera: Boolean,
   internal val showCloseButton: Boolean,
+  internal val keepScreenOn: Boolean,
 ) {
 
   public class Builder {
@@ -27,6 +28,7 @@ public class ScannerConfig internal constructor(
     private var horizontalFrameRatio: Float = 1f
     private var useFrontCamera: Boolean = false
     private var showCloseButton: Boolean = false
+    private var keepScreenOn: Boolean = false
 
     /**
      * Set a list of interested barcode formats. List must not be empty.
@@ -71,19 +73,25 @@ public class ScannerConfig internal constructor(
      */
     public fun setShowCloseButton(enable: Boolean): Builder = apply { showCloseButton = enable }
 
+    /**
+     *  Keep the device's screen turned on as long as the scanner is visible.
+     */
+    public fun setKeepScreenOn(enable: Boolean): Builder = apply { keepScreenOn = enable }
+
     /**
      * Build the BarcodeConfig required by the ScanBarcode ActivityResultContract.
      */
     public fun build(): ScannerConfig =
       ScannerConfig(
-        barcodeFormats.map { it.value }.toIntArray(),
-        overlayStringRes,
-        overlayDrawableRes,
-        hapticSuccessFeedback,
-        showTorchToggle,
-        horizontalFrameRatio,
-        useFrontCamera,
-        showCloseButton,
+        formats = barcodeFormats.map { it.value }.toIntArray(),
+        stringRes = overlayStringRes,
+        drawableRes = overlayDrawableRes,
+        hapticFeedback = hapticSuccessFeedback,
+        showTorchToggle = showTorchToggle,
+        horizontalFrameRatio = horizontalFrameRatio,
+        useFrontCamera = useFrontCamera,
+        showCloseButton = showCloseButton,
+        keepScreenOn = keepScreenOn,
       )
   }
 

quickie/src/main/kotlin/io/github/g00fy2/quickie/extensions/ScannerConfigExtensions.kt

@@ -13,4 +13,5 @@ internal fun ScannerConfig.toParcelableConfig() =
     horizontalFrameRatio = horizontalFrameRatio,
     useFrontCamera = useFrontCamera,
     showCloseButton = showCloseButton,
+    keepScreenOn = keepScreenOn,
   )

sample/src/main/kotlin/io/github/g00fy2/quickiesample/MainActivity.kt

@@ -49,6 +49,7 @@ class MainActivity : AppCompatActivity() {
           setShowCloseButton(true) // show or hide (default) close button
           setHorizontalFrameRatio(2.2f) // set the horizontal overlay ratio (default is 1 / square frame)
           setUseFrontCamera(false) // use the front camera
+          setKeepScreenOn(true) // keep the device's screen turned on
         }
       )
     }