Resource Base
Table of contents

How to Set a Scan Region

Set a Scan Region

  • Objective-C
  • Swift
  1. DSRect *scanRegion = [[DSRect alloc] init];
    scanRegion.top = 0.3;
    scanRegion.bottom = 0.7;
    scanRegion.left = 0.15;
    scanRegion.right = 0.85;
    scanRegion.measuredInPercentage = true;
    [self.dce setScanRegion:scanRegion error:&error];
    
  2. let scanRegion = Rect.init()
    scanRegion.top = 0.3
    scanRegion.bottom = 0.7
    scanRegion.left = 0.15
    scanRegion.right = 0.85
    scanRegion.measuredInPercentage = true
    try? dce.setScanRegion(scanRegion)
    

Add Scan Region Mask & Scan Laser on Camera View

Use the following code to set scan region mask and scan laser.

  • Objective-C
  • Swift
  1. [self.cameraView setScanRegionMaskVisible:true];
    [self.cameraView setScanLaserVisible:true];
    UIColor *strokeColor = [[UIColor alloc] initWithRed:255 green:167 blue:0 alpha:1];
    UIColor *surroundingColor = [[UIColor alloc] initWithRed:0 green:0 blue:0 alpha:0.1];
    [self.cameraView setScanRegionMaskStyle:strokeColor strokeWidth:1 surroundingColour:surroundingColor];
    
  2. cameraView.scanRegionMaskVisible = true
    cameraView.scanLaserVisible = true
    cameraView.setScanRegionMaskStyle(UIColor.init(red: 255, green: 167, blue: 0, alpha: 1), strokeWidth: 1, surroundingColour: UIColor.init(red: 0, green: 0, blue: 0, alpha: 0.1))
    

Configure your own Scan Region UI

You can either use the CameraView to create the scan region UI or draw it youself.

Since the scan region is set for the video streaming, its coordinate system might not be the same with the view coordinate system. You can use the following code to get the scan region Rect under the view coordinate system:

  • Objective-C
  • Swift
  1. CGRect rect = [self.dce convertRectToViewCoordinates:scanRegion];
    
  2. let rect:CGRect = dce.convertRectToViewCoordinates(scanRegion)
    

You can disable the default scan region UI with the following code:

  • Objective-C
  • Swift
  1. [self.cameraView setScanRegionMaskVisible:false];
    [self.cameraView setScanLaserVisible:false];
    
  2. cameraView.scanRegionMaskVisible = false
    cameraView.scanLaserVisible = false
    

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 4.x
      • Version 4.2.0
      • Version 4.0.2
      • Version 4.0.1
      • Version 4.0.0
    • Version 3.x
      • Version 3.0.3
      • Version 3.0.2
      • Version 3.0.1
      • Version 3.0.0
    • Version 2.x
      • Version 2.3.21
      • Version 2.3.20
      • Version 2.3.12
      • Version 2.3.11
      • Version 2.3.10
      • Version 2.3.5
      • Version 2.3.4
      • Version 2.3.3
      • Version 2.3.2
      • Version 2.3.1
      • Version 2.3.0
      • Version 2.1.4
      • Version 2.1.3
      • Version 2.1.1
      • Version 2.0.0
    Change +