Package 

Interface CaptureView.UISettings

  • 
public interface CaptureView.UISettings

    Settings for tuning the user interface appearance.

    The elements of the user interface can be customized according to the implementation of your application needs and its design. The buttons for enabling flashlight or manual capturing can be hidden. A special color can be chosen for the main UI elements. Generally two color themes are provided, so you do not need to set the whole interface appearance manually.

    • Method Detail

      • setFlashlightButtonVisible

        @MainThread() abstract Unit setFlashlightButtonVisible(Boolean isVisible)

        Shows or hides the flashlight button.

        Parameters:
        isVisible - This parameter defines if the button for turning the flashlight on should be visible.

      • setCaptureButtonVisible

        @MainThread() abstract Unit setCaptureButtonVisible(Boolean isVisible)

        Shows or hides the button for taking photo manually.

        Parameters:
        isVisible - This parameter defines if the button for taking photo manually should be visible.

      • setGalleryButtonVisible

        @MainThread() abstract Unit setGalleryButtonVisible(Boolean isVisible)

        Shows or hides the button for choosing an image from photo gallery.

        Parameters:
        isVisible - This parameter defines if the button should be visible.

      • isGalleryButtonVisible

        @MainThread() abstract Boolean isGalleryButtonVisible()

        Checks if the button for choosing an image from photo gallery is visible.

      • setTheme

        @MainThread()@Deprecated(message = "Theme customization is no longer supported") abstract Unit setTheme(CaptureView.UISettings.Theme theme)

        Sets chosen theme for the user interface.

        Parameters:
        theme - The chosen color theme of the user interface appearance, represented by a constant of the Theme enumeration.

      • setCustomColor

        @MainThread() abstract Unit setCustomColor(@ColorRes() Integer colorRes)

        Sets a custom color of the button for manual taking photo.

        Parameters:
        colorRes - The custom color resource reference in the integer format

      • getCustomColor

        @MainThread() abstract Integer getCustomColor()

        Returns defined color of the button for manual taking photo.

      • setAutoCaptureButtonVisible

        @MainThread() abstract Unit setAutoCaptureButtonVisible(Boolean isVisible)

        Shows or hides the button for automatic capture.

        Parameters:
        isVisible - This parameter defines if the button should be visible.

      • setCancelButtonVisible

        @MainThread() abstract Unit setCancelButtonVisible(Boolean isVisible)

        Shows or hides the cancel button, that closes the view.

        Parameters:
        isVisible - This parameter defines if the button should be visible.

      • isCancelButtonVisible

        @MainThread() abstract Boolean isCancelButtonVisible()

        Checks if the cancel button, that closes the view, is visible.