Lantern

Additional

Language
Java
Version
N/A
Created
May 28, 2017
Updated
Nov 9, 2017
Owner
Nishant Srivastava (nisrulz)
Contributor
Nishant Srivastava (nisrulz)
1
Activity
Badge
Generate
Download
Source code
APK file

Advertisement

Lantern 

Android library handling flashlight for camera and camera2 api. Added support for handling display/screen light.

Built with ❤︎ by Nishant Srivastava and contributors


Including in your project

Lantern is available in the Jcenter, so getting it as simple as adding it as a dependency

implementation 'com.github.nisrulz:lantern:{latest version}'

where {latest version} corresponds to published version in

Usage

Handling Flashlight states

  1. Declare permissions in your app's AndroidManifest.xml file

    <!-- Permissions : Allows access to flashlight -->
    <uses-permission android:name="android.permission.CAMERA"/>
    <uses-permission android:name="android.permission.FLASHLIGHT"/>
  2. Init code.

    Make sure you have checked for Manifest.permission.Camera permission first

    Lantern.getInstance().init(context);
  3. Manage states via

    • Turn On

      Lantern.getInstance().turnOnFlashlight(context);
    • Turn Off

      Lantern.getInstance().turnOffFlashlight(context);

Handling Display/Screen states

  1. Declare permissions in your app's AndroidManifest.xml file

    <!-- Permissions : Allows access to change settings -->
    <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
  2. Keep screen on

    • Enable: Keep display on

      Lantern.getInstance().keepDisplayOn(activity)
    • Disable: Keep display on

      Lantern.getInstance().clearKeepDisplayOn(activity)

Below requires that you have permission to write to system settings.

  1. Make use of helper functions

    • Check if the permission to write to system settings is granted or not

      Lantern.getInstance().checkSystemWritePermission(activity)
    • If not granted, request for the same

      Lantern.getInstance().requestSystemWritePermission(activity)
  2. Handle states

    • Set display/screen to full bright state

      Lantern.getInstance().setDisplayToFullBright(activity)
    • Reset display/screen to auto-bright state

      Lantern.getInstance().resetDisplayToAutoBright(activity)

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults. The code style used in this project is from Grandcentrix, so please use the same when editing this project.
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Have fun!

License

Licensed under the Apache License, Version 2.0, click here for the full license.

Author & support

This project was created by Nishant Srivastava but hopefully developed and maintained by many others. See the the list of contributors here.

If you appreciate my work, consider buying me a cup of ☕️ to keep me recharged 🤘

  • PayPal
  • Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL

I love using my work and I'm available for contract work. Freelancing helps to maintain and keep my open source projects up to date!