msoftware/lantern

[Android Library] Handling flashlight for camera and camera2 api. Added support for handling display/screen light

Lantern

Specs

Show some ❤️

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

Including in your project

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

compile '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.
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!

Created & Maintained By

Nishant Srivastava (@nisrulz)

If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕

License

Copyright 2017 Nishant Srivastava

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.