@sapui5/sap.ndc 1.96.8 → 1.96.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/sap.ndc",
-  "version": "1.96.8",
+  "version": "1.96.9",
   "description": "SAPUI5 Library sap.ndc",
   "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
   "author": "SAP SE (https://www.sap.com)",

package/src/sap/ndc/.library

@@ -5,7 +5,7 @@
     <vendor>SAP SE</vendor>
     <copyright>SAPUI5
  * (c) Copyright 2009-2021 SAP SE. All rights reserved.</copyright>
-    <version>1.96.8</version>
+    <version>1.96.9</version>
 
     <documentation>SAPUI5 library with controls with native device capabilities.</documentation>
 

package/src/sap/ndc/BarcodeScanner.js

@@ -23,9 +23,10 @@ sap.ui.define([
 		'sap/m/Button',
 		'sap/m/Dialog',
 		"sap/ui/dom/includeStylesheet",
-		"./BarcodeScannerUIContainer"
+		"./BarcodeScannerUIContainer",
+		"sap/m/MessageToast"
 	],
-	function(Log, JSONModel, ResourceModel, Input, Label, Button, Dialog, includeStylesheet, BarcodeScannerUIContainer) {
+	function(Log, JSONModel, ResourceModel, Input, Label, Button, Dialog, includeStylesheet, BarcodeScannerUIContainer, MessageToast) {
 	"use strict";
 
 	/*global cordova*/
@@ -82,6 +83,8 @@ sap.ui.define([
 			}
 		},
 		oPreferFrontCamera,
+		oFrameRate,
+		oZoom,
 
 		oBarcodeScannerUIContainer = null,
 
@@ -284,6 +287,10 @@ sap.ui.define([
 			} else {
 				defaultConstraints.video.facingMode = 'environment';
 			}
+			// Reset frameRate
+			if (defaultConstraints.video.frameRate !== undefined) {
+				delete defaultConstraints.video.frameRate;
+			}
 			navigator.mediaDevices
 				.getUserMedia(defaultConstraints)
 				.then(
@@ -390,7 +397,16 @@ sap.ui.define([
 				if (!oBarcodeVideoDOM) {
 					oBarcodeVideoDOM = oBarcodeScannerUIContainer ? oBarcodeScannerUIContainer.getDomRef('video') : undefined;
 				}
-
+				if (typeof oFrameRate === "number" && oFrameRate > 0) {
+					defaultConstraints.video.frameRate = oFrameRate;
+				} else if (typeof oFrameRate !== 'undefined') {
+					MessageToast.show(
+						oResourceModel.getResourceBundle().getText('BARCODE_DIALOG_CAMERA_UPDATE_PARAMETER_ERROR_MSG', 'frameRate'),
+						{
+							duration: 1000
+						}
+					);
+				}
 				oZXingScannerAPI.decodeFromConstraints(defaultConstraints, oBarcodeScannerUIContainer.getId() + '-video', function (result, err) {
 					oScanFrame();
 					if (result) {
@@ -492,6 +508,8 @@ sap.ui.define([
 			oBarcodeOverlayDOM = oBarcodeScannerUIContainer.getDomRef('overlay');
 		}
 
+		updateZoom();
+
 		if (oBarcodeOverlayDOM) {
 			var oBarcodeOverlayWidthTemp = oBarcodeVideoDOM.clientWidth * (1 - 2 * iInactiveZonePercent);
 			var oBarcodeOverlayHeightTemp = oBarcodeVideoDOM.clientHeight * (1 - 2 * iInactiveZonePercent);
@@ -511,6 +529,60 @@ sap.ui.define([
 		}
 	}
 
+	function updateZoom() {
+		if (oZoom !== "skipUpdateZoom" && oBarcodeVideoDOM) {
+			var videoTrack = oBarcodeVideoDOM.srcObject.getVideoTracks();
+			var oSupport = window.navigator.mediaDevices.getSupportedConstraints();
+			var capabilities = videoTrack[0].getCapabilities();
+			// Verify the permission about updating zoom
+			if (oSupport.zoom && capabilities && capabilities.zoom) {
+				Log.debug("Support zoom to update");
+				if (typeof oZoom === 'undefined' || oZoom === null) {
+					// reset zoom
+					oZoom = capabilities.zoom.min;
+				}
+			} else {
+				Log.debug("Don't support zoom or getCapabilities() failed.");
+				oZoom = "skipUpdateZoom";
+				return;
+			}
+			// Update zoom
+			try {
+				videoTrack[0].applyConstraints(
+					{
+						advanced: [{
+							zoom: oZoom
+						}]
+					}
+				).then(
+					function() {
+						oZoom = "skipUpdateZoom";
+						Log.debug("The zoom is updated successfully.");
+					}
+				).catch(
+					function(error) {
+						if (error && error.message && error.message.match(/out of range|Failed to read the 'zoom' property/i)) {
+							oZoom = "skipUpdateZoom";
+							MessageToast.show(
+								oResourceModel.getResourceBundle().getText('BARCODE_DIALOG_CAMERA_UPDATE_PARAMETER_ERROR_MSG', 'zoom'),
+								{
+									duration: 1000
+								}
+							);
+						} else {
+							Log.error("Update zoom failed. Error Message:" + error);
+						}
+					}
+				);
+			} catch (err) {
+				Log.error("applyConstraints() failed. Error Message:" + err);
+				oZoom = "skipUpdateZoom";
+			}
+			var settings = videoTrack[0].getSettings();
+			Log.debug("frameRate is " + settings.frameRate + ". zoom is " + settings.zoom);
+		}
+	}
+
 	function closeZXingScanContain() {
 		if (oZXingScannerAPI) {
 			oZXingScannerAPI.reset();
@@ -551,7 +623,10 @@ sap.ui.define([
 	 *		function (mParams) {
 	 *			alert("Value entered: " + mParams.newValue);
 	 *		},
-	 *		"Enter Product Bar Code"
+	 *		"Enter Product Bar Code",
+	 *		true,
+	 *		30,
+	 *		1
 	 * 	);
 	 * });
 	 * </pre>
@@ -560,11 +635,14 @@ sap.ui.define([
 	 * @param {function} [fnFail] Function to be called when the scanning is failed
 	 * @param {function} [fnLiveUpdate] Function to be called when value of the dialog's input is changed
 	 * @param {string} [dialogTitle] Defines the bar code input dialog title. If unset, a predefined title will be used.
+	 * @param {boolean} [preferFrontCamera] Flag, which defines whether the front or back camera should be used.
+	 * @param {float} [frameRate] Defines the frame rate of the camera.
+	 * @param {float} [zoom] Defines the zoom of the camera. This parameter is not supported on iOS.
 	 *
 	 * @public
 	 * @static
 	 */
-	BarcodeScanner.scan = function (fnSuccess, fnFail, fnLiveUpdate, dialogTitle, preferFrontCamera) {
+	BarcodeScanner.scan = function (fnSuccess, fnFail, fnLiveUpdate, dialogTitle, preferFrontCamera, frameRate, zoom) {
 		if (!bReady) {
 			Log.error("Barcode scanning is already in progress.");
 			return;
@@ -572,6 +650,8 @@ sap.ui.define([
 
 		bReady = false;
 		oPreferFrontCamera = preferFrontCamera;
+		oFrameRate = frameRate;
+		oZoom = zoom;
 
 		if (oStatusModel.getProperty("/available") == true && oCordovaScannerAPI == null && oZXingScannerAPI == null){
 			//in case we do not have feature vectore we still would like to allow the use

package/src/sap/ndc/BarcodeScannerButton.js

@@ -57,7 +57,16 @@ sap.ui.define(["sap/ui/thirdparty/jquery", './BarcodeScanner', './library', 'sap
 			/**
 			 * If set to true, the front camera will be used to decode.
 			 */
-			preferFrontCamera : {type : "boolean", defaultValue : false}
+			preferFrontCamera : {type : "boolean", defaultValue : false},
+
+			/**
+			 * Defines the frame rate of the camera.
+			 */
+			frameRate : {type : "float"},
+			/**
+			 * Defines the zoom of the camera. This parameter is not supported on iOS.
+			 */
+			zoom : {type : "float"}
 		},
 		aggregations : {
 
@@ -131,7 +140,9 @@ sap.ui.define(["sap/ui/thirdparty/jquery", './BarcodeScanner', './library', 'sap
 			jQuery.proxy(this._onScanFail, this),
 			jQuery.proxy(this._onInputLiveUpdate, this),
 			this.getProperty("dialogTitle"),
-			this.getProperty("preferFrontCamera")
+			this.getProperty("preferFrontCamera"),
+			this.getProperty("frameRate"),
+			this.getProperty("zoom")
 		);
 	};
 

package/src/sap/ndc/library.js

@@ -32,7 +32,7 @@ sap.ui.define(['sap/m/library', 'sap/ui/core/library'],
 		],
 		elements: [],
 		noLibraryCSS: true,
-		version: "1.96.8"
+		version: "1.96.9"
 	});
 
 	return sap.ndc;

package/src/sap/ndc/messagebundle.properties

@@ -1,17 +1,20 @@
-#This is the resource bundle for the sap.ndc library
-#__ldi.translation.uuid=242cacb8-b0ca-42c0-980c-c7eeb3ce9a2b
-
-#XTIT: title of the manual bar code input
-BARCODE_DIALOG_TITLE=Enter Bar Code
-
-#XBUT: OK button in the manual bar code input dialog
-BARCODE_DIALOG_OK=OK
-
-#XBUT: Cancel button in the manual bar code input dialog
-BARCODE_DIALOG_CANCEL=Cancel
-
-#XFLD: Placeholder of the bar code input field
-BARCODE_DIALOG_PLACEHOLDER=Enter bar code
-
-#YMSG: Message in the manual bar code input dialog
-BARCODE_DIALOG_MSG=Scanner is not available
+#This is the resource bundle for the sap.ndc library
+#__ldi.translation.uuid=242cacb8-b0ca-42c0-980c-c7eeb3ce9a2b
+
+#XTIT: title of the manual bar code input
+BARCODE_DIALOG_TITLE=Enter Bar Code
+
+#XBUT: OK button in the manual bar code input dialog
+BARCODE_DIALOG_OK=OK
+
+#XBUT: Cancel button in the manual bar code input dialog
+BARCODE_DIALOG_CANCEL=Cancel
+
+#XFLD: Placeholder of the bar code input field
+BARCODE_DIALOG_PLACEHOLDER=Enter bar code
+
+#YMSG: Message in the manual bar code input dialog
+BARCODE_DIALOG_MSG=Scanner is not available
+
+#XMSG: error message for updating parameter of Camera
+BARCODE_DIALOG_CAMERA_UPDATE_PARAMETER_ERROR_MSG=The {0} parameter is out of range.