Configuration¶

The SDK can be configured by providing a Map to the SDK. This map may contain one or more of the following key/value pairs, sorted alphabetically:

VDDocumentConfiguration.ADVANCED_DETECTION_ENABLED : whether a generic rectangle detector after the initial smart detection (if all documents are smart) is set or not. ("YES"/"NO").
VDDocumentConfiguration.ADVANCED_DETECTION_OBVERSE_DELAY : Seconds to wait before start rectangle detection after smart on the obverse.
VDDocumentConfiguration.ADVANCED_DETECTION_REVERSE_DELAY : Seconds to wait before start rectangle detection after smart on the reverse.
VDDocumentConfiguration.ADVANCED_DETECTION_DEFERRED : Enables or disables deferred detection where the actual detection only starts when a document is shown.
VDDocumentConfiguration.ALERT_STYLE : The style for the alerts in the SDK. It can be black or white.
VDDocumentConfiguration.ARROW_COLOR_1 : The color of the first guiding arrow for the document.
VDDocumentConfiguration.ARROW_COLOR_2 : The color of the second guiding arrow for the document.
VDDocumentConfiguration.ARROW_COLOR_3 : The color of the third guiding arrow for the document.
VDDocumentConfiguration.ARROW_COLOR_4 : The color of the forth guiding arrow for the document.
VDDocumentConfiguration.ARROW_COLOR_5 : The color of the fifth guiding arrow for the document.
VDDocumentConfiguration.ARROWS : Whether the SDK may have to show the guiding arrows for the document or not. ("YES"/"NO")
VDDocumentConfiguration.BAD_QUALITY_PICTURE_INFO : The html text to inform the user that the quality of the picture is no good enough.
VDDocumentConfiguration.CAMERA_ERROR_ALERT_TITLE : Title for the alert when a camera error occurs.
VDDocumentConfiguration.CAMERA_ERROR_ALERT : Text for the alert when a camera error occurs.
VDDocumentConfiguration.CAPTURE_BACKGROUND_COLOR : Changes the background color of the cap- ture screen. ("#XXXXXX" a color in hexadecimal value, for translucent colors use #XXXXXXXX)
VDDocumentConfiguration.CAPTURE_BRIGHTS_DETECTION_ENABLED : Enable the detection of brightness on capture.
VDDocumentConfiguration.CAPTURE_BRIGHTS_DETECTION_INFO_TEXT : The text to show when one or more bright spots have been found.
VDDocumentConfiguration.CHECK_DOCUMENT_TEXT : The text that is shown to inform the user in the revision of the document photo.
VDDocumentConfiguration.CHECK_DOCUMENT_TEXT_COLOR : The text color for the text that is shown to inform the user in the revision of the document photo.
VDDocumentConfiguration.CLOSE_BUTTON: Whether the SDK may have a close button or not. ("YES"/"NO")
VDDocumentConfiguration.CLOSE_BUTTON_IMAGE: The name of the image for the close button, it should be stored in the app res/drawable folder.
VDDocumentConfiguration.CONTINUE_BUTTON_BACKGROUND_COLOR : The color of the continue button in the document photo verification.
VDDocumentConfiguration.CONTINUE_BUTTON_ICON: The name of the image for the continue button, it should be stored in the app res/drawable folder.
VDDocumentConfiguration.CONTINUE_BUTTON_TEXT : The text of the continue button in the document photo verification.
VDDocumentConfiguration.CONTINUE_BUTTON_TEXT_COLOR : The color of the text of the continue button in the document photo verification.
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL1_COLOR: Template and text color when document is detected in the correct position. Level 1. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL2_COLOR: Template and text color when document is detected in the correct position. Level 2. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL3_COLOR: Template and text color when document is detected in the correct position. Level 3. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.DOCUMENT_DETECTED_VERY_CLOSE_COLOR: Template color when document is detected but it is very close. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.DOCUMENT_DETECTED_VERY_FAR_COLOR: Template color when document is detected but it is very far. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.DOCUMENT_VERY_CLOSE : The text to show when the document is located but too close to the device.
VDDocumentConfiguration.DOCUMENT_VERY_FAR : The text to show when the document is located but far from the device.
VDDocumentConfiguration.FACING : The front or back camera. ("front"/"back") defaults to "back".
VDDocumentConfiguration.FIXED_RECTANGLE : Whether the SDK may have the fixed rectangle to fit with the document or not. ("YES"/"NO")
VDDocumentConfiguration.FIXED_TEMPLATE : Whether the SDK may have the fixed template to help fit the document or not. ("YES"/"NO")
VDDocumentConfiguration.FLASH_WAITING_ALERT : The text to show between the no-flash/flash images capture time.
VDDocumentConfiguration.FLASH_WAITING_ALERT_ANIMATION_IMAGE: The name of the image for the flash waiting alert, it should be stored in the app res/drawable folder.
VDDocumentConfiguration.FLASH_WAITING_ALERT_STYLE: The name of the custom style for the flash waiting alert.
VDDocumentConfiguration.FLASH_WAITING_ALERT_TEXT_COLOR: The color of the text to show between the no-flash/flash images capture time.
VDDocumentConfiguration.INFO_ALERT : The text to show at the beginning of the capture to inform the user.
VDDocumentConfiguration.INFO_ALERT_PASS : The text to show at the beginning of the capture to inform the user when is going to be captured.
VDDocumentConfiguration.INFO_ALERT_SHOW: Whether the initial alert must be shown or not.("YES","NO")
VDDocumentConfiguration.INFO_ALERT_TITLE : The title of the alert showed at the beginning of the capture.
VDDocumentConfiguration.INFO_ALERT_TITLE_PASS : The title of the alert showed at the beginning of the capture when passport is going to be captured.
VDDocumentConfiguration.INFORMATIVE_BUTTON_ICON : The icon of the help button in the review screen, it should be stored in the app res/drawable folder.
VDDocumentConfiguration.INFORMATIVE_TEXT_COLOR : The color of the text of the informative label shown to the user. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.LOGGER_FACTORY_CLASS : The logger factory class which will create a logger instance.
VDDocumentConfiguration.OBVERSE_DETECTION_DELAY : Seconds to wait to start searching for the document obverse. ("YES"/"NO")
VDDocumentConfiguration.OBVERSE_FLASH : Whether the SDK may have to take obverse with flash image or not. ("YES"/"NO")
VDDocumentConfiguration.OBVERSE_NOT_FOUND_TEXT : The text to show when the obverse is not found.
VDDocumentConfiguration.ONLY_OBVERSE: Whether or not the SDK will take only the obverse and not the reverse picture. ("YES"/"NO")
VDDocumentConfiguration.ON_PICTURE_VIBRATION: Whether or not the device should vibrate when the picture is taken. ("YES"/"NO")
VDDocumentConfiguration.PASSPORT_NOT_FOUND_TEXT : The text to show when the passport is not found.
VDDocumentConfiguration.PERMISSION_REFUSED : The text for the alert when a permission is not allowed.
VDDocumentConfiguration.PERMISSION_REFUSED_TITLE : The title for the alert when a permission is not allowed.
VDDocumentConfiguration.POPUP_VALIDATION_BACKGROUND_COLOR : The background color of the text to show when the user hits the help button in the document photo verification. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.POPUP_VALIDATION_TEXT_COLOR : The color of the text to show when the user hits the help button in the document photo verification. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.POSITIVE_BUTTON_TEXT : The text of the all positive buttons.
VDDocumentConfiguration.PRIORITY : Whether the SDK should prioritize the capture or the classification. ("capture"/"classification")
VDDocumentConfiguration.REPEAT_BUTTON_BACKGROUND_COLOR : The color of the repeat button in the document photo verification.
VDDocumentConfiguration.REPEAT_BUTTON_ICON: The name of the image for the repeat button, it should be stored in the app res/drawable folder
VDDocumentConfiguration.REPEAT_BUTTON_TEXT : The text of the repeat button in the document photo verification.
VDDocumentConfiguration.REPEAT_BUTTON_TEXT_COLOR : The color of the text of the repeat button in the document photo verification.
VDDocumentConfiguration.REPEAT_NO_FLASH_ALERT: The text for the alert to inform the user that the process will be repeated because there was no flash centered in the document.
VDDocumentConfiguration.REPEAT_NO_FLASH_ALERT_TITLE: The title for the alert to inform the user that the process will be repeated because there was no flash centered in the document.
VDDocumentConfiguration.REQUIREMENTS_ALERT_MESSAGE: The message for the alert to inform the user that the device not comply the hardware requirements.
VDDocumentConfiguration.REQUIREMENTS_ALERT_TITLE: The title for the alert to inform the user that the device not comply the hardware requirements.
VDDocumentConfiguration.REVERSE_DETECTION_DELAY : The seconds to wait until start searching the reverse of the document.
VDDocumentConfiguration.REVERSE_NOT_FOUND_TEXT : The text to show when the reverse is not found.
VDDocumentConfiguration.SECONDS_WITHOUT_PICTURE: Seconds to wait before warning the user not been able to complete the process.
VDDocumentConfiguration.SECONDS_WITHOUT_SHUTTER_BUTTON_OBVERSE : Seconds before showing a button to take the picture in case the detection isn't working for the obverse. (Must never be less than ADVANCED_DETECTION_OBVERSE_DELAY)
VDDocumentConfiguration.SECONDS_WITHOUT_SHUTTER_BUTTON_REVERSE : Seconds before showing a button to take the picture in case the detection isn't working for the reverse. (Must never be less than ADVANCED_DETECTION_REVERSE_DELAY)
VDDocumentConfiguration.SECONDS_WITH_SHUTTER_BUTTON_MESSAGE : Duration of the explanation message for the shutter button.
VDDocumentConfiguration.SHOW_DOCUMENT : Whether the SDK will show the document taken to verify it is correct. ("YES"/"NO")
VDDocumentConfiguration.SHOW_TUTORIAL : Whether the SDK will show a tutorial at the start of the SDK. ("YES"/"NO")
VDDocumentConfiguration.SHUTTER_BUTTON_BACKGROUND_COLOR : Shutter button color.
VDDocumentConfiguration.SHUTTER_BUTTON_BORDER_COLOR : Shutter button border color.
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE : Explanation message for the shutter button.
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE_BACKGROUND_COLOR : Color for the background of the explanation message for the shutter button.
VDDocumentConfiguration.SHUTTER_BUTTON_SHOW : Whether or not the shutter button should appear.
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE_TEXT_COLOR : The color of the explanation message for the shutter button.
VDDocumentConfiguration.TEXT_BACKGROUND_COLOR : The background color of texts which appears in capture screens or in the help sections. ("#XXXXXX" a color in hexadecimal value)
VDDocumentConfiguration.TICK_CIRCLE_COLOR : Color of the circle of the tick image. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TICK_COLOR : Color for the tick of the tick image. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TUTORIAL_ALTERNATIVE_PATH : Path to a png that will replace the gif in case it does not exist. Should be located in assets folder and loaded with path: some-name.png or file:///android_asset/some-name.png.
VDDocumentConfiguration.TUTORIAL_BACKGROUND_COLOR : Background color of the tutorial view. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_COLOR : Color of the continue button. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_TEXT : Text of the continue button.
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_TEXT_COLOR : Color of the text of the continue button. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TUTORIAL_GIF_PATH : Path to a gif to be shown at the tutorial view. Should be located in assets folder and loaded with path: some-name.gif or file:///android_asset/some-name.gif.
VDDocumentConfiguration.TUTORIAL_TEXT : Text to be shown to aid the user.
VDDocumentConfiguration.TUTORIAL_TEXT_COLOR : Color of the tutorial aid. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.TUTORIAL_TITLE : Title of the tutorial view.
VDDocumentConfiguration.TUTORIAL_TITLE_COLOR : Color of the title of the tutorial view. Supported formats are: #RRGGBB, #AARRGGBB, 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray'.
VDDocumentConfiguration.USER_INFO : The text to show when the user hits the help button in the document photo verification section.
VDDocumentConfiguration.VALIDATE_DOCUMENT_BUTTONS_WIDTH_DIVISOR : The divisor of the button width. The width of the buttons will be calculated by dividing the width of the image shown above in the validation screen.
VDDocumentConfiguration.VALIDATION_BACKGROUND_COLOR : The background color in the document photo verification section. ("#XXXXXX" a color in hexadecimal value)

The default values for these keys are:

KEY	Default Value
VDDocumentConfiguration.ADVANCED_DETECTION_ENABLED	"NO"
VDDocumentConfiguration.ADVANCED_DETECTION_OBVERSE_DELAY	"6"
VDDocumentConfiguration.ADVANCED_DETECTION_REVERSE_DELAY	"6"
VDDocumentConfiguration.ADVANCED_DETECTION_DEFERRED	"NO"
VDDocumentConfiguration.ALERT_STYLE	"black"
VDDocumentConfiguration.ARROW_COLOR_1	"#FF006EC1"
VDDocumentConfiguration.ARROW_COLOR_2	"#FF009EE5"
VDDocumentConfiguration.ARROW_COLOR_3	"#FF52BCEC"
VDDocumentConfiguration.ARROW_COLOR_4	"#FF89D1F3"
VDDocumentConfiguration.ARROW_COLOR_5	"#FFB5E5F9"
VDDocumentConfiguration.ARROWS	"YES"
VDDocumentConfiguration.BAD_QUALITY_PICTURE_INFO	" It seems that the quality of the image is not enough. Please, repeat the photo in a place with good lighting. " " Parece que la calidad de la imagen no es suficiente. Por favor, repita la foto en un lugar con buena iluminación. "
VDDocumentConfiguration.CAMERA_ERROR_ALERT	"Please try again." "Por favor, inténtelo de nuevo"
VDDocumentConfiguration.CAMERA_ERROR_ALERT_TITLE	"There has been an error with the camera." "Ha habido un error con la cámara."
VDDocumentConfiguration.CAPTURE_BACKGROUND_COLOR	"#CC808080"
VDDocumentConfiguration.CAPTURE_BRIGHTS_DETECTION_ENABLED	"NO"
VDDocumentConfiguration.CAPTURE_BRIGHTS_DETECTION_INFO_TEXT	" Bright spots have been detected. Please, repeat the photo without bright spots. " " Brillos detectados. Por favor, inténtelo de nuevo sin brillos. "
VDDocumentConfiguration.CHECK_DOCUMENT_TEXT	"If the photo is clear, press CONTINUE." "Si la foto se ve bien, pulsa CONTINUAR."
VDDocumentConfiguration.CHECK_DOCUMENT_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.CLOSE_BUTTON	"NO"
VDDocumentConfiguration.CLOSE_BUTTON_IMAGE	VDDocumentConfiguration.UNDEFINED
VDDocumentConfiguration.CONTINUE_BUTTON_BACKGROUND_COLOR	"#116466"
VDDocumentConfiguration.CONTINUE_BUTTON_ICON	VDDocumentConfiguration.UNDEFINED
VDDocumentConfiguration.CONTINUE_BUTTON_TEXT	"CONTINUE" "CONTINUAR"
VDDocumentConfiguration.CONTINUE_BUTTON_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL1_COLOR	"#00FF00"
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL2_COLOR	"#3FFF7F"
VDDocumentConfiguration.DOCUMENT_DETECTED_OK_LEVEL3_COLOR	"#7FFFD4"
VDDocumentConfiguration.DOCUMENT_DETECTED_VERY_CLOSE_COLOR	"#FC321E"
VDDocumentConfiguration.DOCUMENT_DETECTED_VERY_FAR_COLOR	"#094FA4"
VDDocumentConfiguration.DOCUMENT_VERY_CLOSE	"Too close!\nPlace the device further" "¡Demasiado cerca!\nAleje el dispositivo"
VDDocumentConfiguration.DOCUMENT_VERY_FAR	"Too far!\nPlace the device closer" "¡Demasiado lejos!\nAcerque el dispositivo"
VDDocumentConfiguration.FACING	"back"
VDDocumentConfiguration.FIXED_RECTANGLE	"YES"
VDDocumentConfiguration.FIXED_TEMPLATE	"YES"
VDDocumentConfiguration.FLASH_WAITING_ALERT	"Do not move, we are taking the photo with flash." "No se mueva. Tomando la foto con flash."
VDDocumentConfiguration.FLASH_WAITING_ALERT_ANIMATION_IMAGE	VDDocumentConfiguration.UNDEFINED
VDDocumentConfiguration.FLASH_WAITING_ALERT_STYLE	VDDocumentConfiguration.UNDEFINED
VDDocumentConfiguration.FLASH_WAITING_ALERT_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.INFO_ALERT	"The photos will be taken AUTOMATICALLY." "Se tomarán las fotos AUTOMÁTICAMENTE."
VDDocumentConfiguration.INFO_ALERT_PASS	"The photos will be taken AUTOMATICALLY." "Se tomarán las fotos AUTOMÁTICAMENTE."
VDDocumentConfiguration.INFO_ALERT_SHOW	"YES"
VDDocumentConfiguration.INFO_ALERT_TITLE	""
VDDocumentConfiguration.INFO_ALERT_TITLE_PASS	""
VDDocumentConfiguration.INFORMATIVE_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.LOGGER_FACTORY_CLASS	""
VDDocumentConfiguration.OBVERSE_DETECTION_DELAY	"0"
VDDocumentConfiguration.OBVERSE_FLASH	"NO"
VDDocumentConfiguration.OBVERSE_NOT_FOUND_TEXT	"Fit the FRONT" "Encaje la parte DELANTERA"
VDDocumentConfiguration.ON_PICTURE_VIBRATION	"NO"
VDDocumentConfiguration.ONLY_OBVERSE	"NO"
VDDocumentConfiguration.PASSPORT_NOT_FOUND_TEXT	"Adjust the Passport page" "Ajuste la página \ndel pasaporte"
VDDocumentConfiguration.PERMISSION_REFUSED	"Access to the device camera is needed for the capture and verification of the document and the user." "Se necesita tener acceso a la cámara del dispositivo para la captura y verificación del documento y del usuario."
VDDocumentConfiguration.PERMISSION_REFUSED_TITLE	"Permission required" "Permiso requerido"
VDDocumentConfiguration.PRIORITY	"classification"
VDDocumentConfiguration.POPUP_VALIDATION_BACKGROUND_COLOR	"#AA000000"
VDDocumentConfiguration.POPUP_VALIDATION_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.POSITIVE_BUTTON_TEXT	"CONTINUE" "CONTINUAR"
VDDocumentConfiguration.REPEAT_BUTTON_BACKGROUND_COLOR	"#116466"
VDDocumentConfiguration.REPEAT_BUTTON_ICON	VDDocumentConfiguration.UNDEFINED
VDDocumentConfiguration.REPEAT_BUTTON_TEXT	"REPEAT" "REPETIR"
VDDocumentConfiguration.REPEAT_NO_FLASH_ALERT_TITLE	""
VDDocumentConfiguration.REPEAT_NO_FLASH_ALERT	"The captured photo does not have enough quality. Please, repeat it and make sure to position the document in the frame of reference." "La foto capturada no tiene suficiente calidad. Por favor, repítala y asegúrese de encuadrar el documento en el marco de referencia."
VDDocumentConfiguration.REQUIREMENTS_ALERT_MESSAGE	"Camera with autofocus is needed for quality capture. The process is not available for devices without autofocus." "Es necesario una cámara con autofocus para unas capturas de calidad. El proceso no está disponible para dispositivos sin autofocus."
VDDocumentConfiguration.REQUIREMENTS_ALERT_TITLE	"Hardware requirements" "Requerimientos de Hardware"
VDDocumentConfiguration.REVERSE_DETECTION_DELAY	"0"
VDDocumentConfiguration.REVERSE_NOT_FOUND_TEXT	"Fit the BACKSIDE" "Encaje la parte TRASERA"
VDDocumentConfiguration.SECONDS_WITHOUT_PICTURE	"40"
VDDocumentConfiguration.SECONDS_WITHOUT_SHUTTER_BUTTON_OBVERSE	"10"
VDDocumentConfiguration.SECONDS_WITHOUT_SHUTTER_BUTTON_REVERSE	"10"
VDDocumentConfiguration.SECONDS_WITH_SHUTTER_BUTTON_MESSAGE	"6"
VDDocumentConfiguration.SHOW_DOCUMENT	"YES"
VDDocumentConfiguration.SHOW_TUTORIAL	"NO"
VDDocumentConfiguration.SHUTTER_BUTTON_BACKGROUND_COLOR	"#EAE9E9"
VDDocumentConfiguration.SHUTTER_BUTTON_BORDER_COLOR	"#CCCCCC"
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE	"Tap the button to take the photo" "Presione el botón para\n sacar la foto"
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE_BACKGROUND_COLOR	"#AA000000"
VDDocumentConfiguration.SHUTTER_BUTTON_MESSAGE_TEXT_COLOR	"#FFFFFF"
VDDocumentConfiguration.SHUTTER_BUTTON_SHOW	"YES"
VDDocumentConfiguration.TEXT_BACKGROUND_COLOR	"#AA000000"
VDDocumentConfiguration.TICK_CIRCLE_COLOR	"#FF424242"
VDDocumentConfiguration.TICK_COLOR	"#FFFFFFFF"
VDDocumentConfiguration.TUTORIAL_ALTERNATIVE_PATH	""
VDDocumentConfiguration.TUTORIAL_BACKGROUND_COLOR	"#424242"
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_COLOR	"#116466"
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_TEXT	"CONTINUE" "CONTINUAR"
VDDocumentConfiguration.TUTORIAL_CONTINUE_BUTTON_TEXT_COLOR	"#ffffff"
VDDocumentConfiguration.TUTORIAL_GIF_PATH	""
VDDocumentConfiguration.TUTORIAL_TEXT	"\u2022 Make sure that your document does not present shines or shades.\n\n\u2022 Center your document in the frame.\n\n\u2022 The picture will be taken *AUTOMATICALLY."" ""\t\u2022 Asegúrese de que su documento no muestra brillos o sombras.\n\n\t\u2022 Centre su documento en el marco.\n\n\t\u2022 La fotografía se capturará de forma AUTOMÁTICA*."
VDDocumentConfiguration.TUTORIAL_TEXT_COLOR	"#ffffff"
VDDocumentConfiguration.TUTORIAL_TITLE	"Document Capture" "Captura Documento"
VDDocumentConfiguration.TUTORIAL_TITLE_COLOR	"#424242"
VDDocumentConfiguration.USER_INFO	"Please, check that your document is focused, with no cuts or any type of brightness that may impede a perfect lecture." "Por favor, compruebe que su documento está enfocado, sin cortes y sin ningún tipo de brillo que impida su perfecta lectura"
VDDocumentConfiguration.VALIDATE_DOCUMENT_BUTTONS_WIDTH_DIVISOR	"2.1"
VDDocumentConfiguration.VALIDATION_BACKGROUND_COLOR	"#424242"

Format texts¶

All strings can be formatted by using HTML tags. If the string is stored in an XML file, it should be enclosed in a CDATA section. A CDATA section starts with "<![CDATA[" and ends with "]]>".

Fonts¶

To change the SDK font family, the SDK styles can be overwritten. These are the SDK styles:

General style

<style name="VDDocumentCaptureTheme.NoTitleNavBar" parent="Theme.AppCompat.Light.NoActionBar">
  <item name="android:windowNoTitle">true</item>
  <item name="windowActionBar">false</item>
  <item name="android:windowFullscreen">true</item>
  <item name="android:windowContentOverlay">@null</item>
  <item name="android:statusBarColor" tools:targetApi="lollipop">@android:color/transparent</item>
  <item name="android:windowTranslucentNavigation" tools:targetApi="kitkat">true</item>
</style>

Dialogs style

<style name="VeridasDialog" parent="Theme.AppCompat.Dialog.Alert">
  <item name="colorAccent">@color/dialogButton</item>
  <item name="android:windowBackground">@color/transparent</item>
  <item name="android:background">@color/dialogBackground</item>
</style>

Progress Dialogs style

<style name="VeridasProgressDialog" parent="Theme.AppCompat.Dialog.Alert">
  <item name="colorAccent">@color/dialogButton</item>
  <item name="android:windowBackground">@color/transparent</item>
  <item name="android:background">@color/dialogBackground</item>
  <item name="android:textSize">@dimen/document_face_text_size</item>
</style>

Create a custom Progress Dialog for the flash picture alert¶

To change the appearance of the Progress Dialog that appears while the flash picture is taken, a style should be created whose parent is VeridasProgressDialog. To change the image that rotates, a drawable should be added to res/drawable. If the image should rotate, there should be an XML file that describes the animation.

Example:

/app/src/main/res/drawable/custom_indeterminate_progress.xml file

<?xml version="1.0" encoding="utf-8"?>
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
  <item>
    <rotate
      android:drawable="@drawable/custom_indeterminate_drawable"
      android:fillAfter="true"
      android:fromDegrees="0"
      android:pivotX="50%"
      android:pivotY="50%"
      android:toDegrees="360" />
  </item>
</layer-list>

In /app/src/main/res/values/styles.xml

<style name="customProgressDialog" parent="VeridasProgressDialog">
  <item name="colorAccent">@color/dialogButton</item>
  <item name="android:windowBackground">@color/transparent</item>
  <item name="android:background">#FF0000</item>
  <item name="android:textSize">@dimen/document_face_text_size</item>
  <item name="android:textColor">#00FF00</item>
  <item name="android:indeterminateTint" tools:targetApi="lollipop">#0000FF</item>
</style>

In the configuration map:

configuration.put(VDDocumentConfiguration.FLASH_WAITING_ALERT_ANIMATION_IMAGE, "custom_indeterminate_progress");
configuration.put(VDDocumentConfiguration.FLASH_WAITING_ALERT_STYLE, "customProgressDialog");