DynamsoftCameraEnhancer Class

The main class of DynamsoftCameraEnhancer. It contains APIs that enable user to:

• Implement basic camera control like open, close, change resolution, etc.
• Get frames from the video streaming.
• Enable advanced features including:
  • Frame filtering by sharpness
  • Frame filtering by sensor
  • Enhanced focus
  • Frame cropping
  • Auto zoom
  • Smart torch control

@interface DynamsoftCameraEnhancer:NSObject

Initialization Methods Summary

Basic Camera Control Methods Summary

Frame Acquiring Methods Summary

Enhanced Features Methods Summary

Advanced Camera Control Methods Summary

Initialization Methods Details

initWithView

Initialize the camera enhancer with the DCECameraView.

- (instancetype)initWithView:(DCECameraView *)view;

Return Value

The instance of DynamsoftCameraEnhancer.

Code Snippet

• Objective-C
• Swift

1. _dce = [[DynamsoftCameraEnhancer alloc] initWithView:_dceView];
   

2. let dce = DynamsoftCameraEnhancer.init(view: dceCameraView)
   

getVersion

Get the SDK version of Dynamsoft Camera Enhancer.

+ (NSString*)getVersion;

Return Value

A string value that indicates the version of DynamsoftCameraEnhancer SDK.

Code Snippet

• Objective-C
• Swift

1. NSString* version = [DynamsoftCameraEnhancer getVersion];
   

2. let version = DynamsoftCameraEnhancer.getVersion()
   

cameraView

Bind a DCECameraView to the camera enhancer.

@property (strong, nonatomic) DCECameraView cameraView; 

Code Snippet

• Objective-C
• Swift

1. _dceView = [[DCECameraView alloc] initWithFrame:self.view.bounds]
   [_dce setCameraView:_dceView];
   

2. let dceView = DCECameraView.init(frame self.view.bounds)
   dce.cameraView = dceView
   

Basic Camera Control Methods Details

getAllCameras

Get the IDs of all available cameras.

- (NSArray*)getAllCameras;

Return Value

An NSArray that includes all available cameras. Users can clearly read whether the camera is front-facing, back-facing, or external from the cameraID.

Code Snippet

• Objective-C
• Swift

1. NSArray<NSString*>* allCameras = [_dce getAllCameras];
   

2. let allCameraList = dce.getAllCameras()
   

selectCameraWithPosition

Select the camera position (front-facing or back-facing).

- (void)selectCameraWithPosition:(EnumCameraPosition)position error:(NSError * _Nullable * _Nullable)error;

Parameters

[in] cameraPosition An EnumCameraPosition value that indicates front-facing or back-facing camera.

Code Snippet

• Objective-C
• Swift

1. [_dce selectCameraWithPosition:EnumCameraPositionBack error: &error];
   

2. try? dce.selectCameraWithPosition(EnumCameraPosition.back)
   

getCameraPosition

Returns whether the front-facing camera or back-facing camera is selected.

- (EnumCameraPosition) getCameraPosition;

Return Value

An EnumCameraPosition value that indicates front-facing or back-facing camera.

Code Snippet

• Objective-C
• Swift

1. EnumCameraPosition cameraPosition = [_dce getCameraPosition];
   

2. let cameraPosition = dce.getCameraPosition()
   

selectCamera

Select camera by cameraID. The camera will be selected and further camera control settings will be applied to this camera. When the selected camera is changed via this method, the settings will be inherited by the newly selected camera.

- (void)selectCamera:(NSString*)cameraId error:(NSError * _Nullable * _Nullable)error;

Parameters

[in] cameraID A String value that listed in the cameraIDList returned by getAllCameras. The method will have no effects if the input value does not exist in the cameraIDList.

Code Snippet

• Objective-C
• Swift

1. [_dce selectCamera:@"BACK_FACING_CAMERA" error: &error];
   

2. try? dce.selectCamera("BACK_FACING_CAMERA")
   

Remarks

• There is always a back-facing camera be defined as a default camera. If the user doesn’t select any camera via selectCamera, the default camera will be considered as the selected camera.
• If there is no opened camera, the method selectCamera will not open any camera.
• If there is an opened camera and the opened camera’s ID exactly equals the input ID, the method selectCamera will make no changes.
• If there is an opened camera and the opened camera’s ID is different from the input ID, the method selectCamera will close the currently opened camera and then open a new camera by the input ID.

getSelectedCamera

Get the ID of the currently selected camera.

- (NSString*)getSelectedCamera;

Return Value

The ID of the current selected camera.

Code Snippet

• Objective-C
• Swift

1. NSString* cameraID = [_dce getSelectedCamera];
   

2. let selectedCamera = dce.getSelectedCamera()
   

getCameraState

Get the state of the currently selected camera.

- (EnumCameraState*)getCameraState;

Return Value

One of the preset camera state in Enumeration EnumCameraState.

Code Snippet

• Objective-C
• Swift

1. EnumCameraState state = [_dce getCameraState];
   

2. let cameraState = dce.getCameraState()
   

open

• Turn on the selected camera if a camera has been selected via selectCamera.
• Turn on the default camera if no camera is selected via selectCamera.

- (void)open;

Code Snippet

• Objective-C
• Swift

1. [_dce open];
   

2. dce.open()
   

close

• Turn off the selected camera if a camera has been selected via selectCamera.
• Turn off the default camera if no camera is selected via selectCamera.

- (void)close;

Code Snippet

• Objective-C
• Swift

1. [_dce close];
   

2. dce.close()
   

pause

• Pause the selected camera if a camera has been selected via selectCamera.
• Pause the default camera if no camera is selected via selectCamera.

- (void)pause;

Code Snippet

• Objective-C
• Swift

1. [_dce pause];
   

2. dce.pause()
   

Remarks

If the pause method is triggered:

• The camera UI will be stopped on the last frame captured before you pause the camera.
• The camera is still open.
• The video streaming input is not stopped.
• DCE video buffer will continue appending frames.

resume

• Resume the selected camera if a camera has been selected via selectCamera.
• Resume the default camera if no camera is selected via selectCamera.

- (void)resume;

Code Snippet

• Objective-C
• Swift

1. [_dce resume];
   

2. dce.resume()
   

turnOnTorch

Turn on the torch (if the torch of the mobile device is available).

- (void)turnOnTorch;

Code Snippet

• Objective-C
• Swift

1. [_dce turnOnTorch];
   

2. dce.turnOnTorch()
   

turnOffTorch

Turn off the torch.

- (void)turnOffTorch;

Code Snippet

• Objective-C
• Swift

1. [_dce turnOffTorch];
   

2. dce.turnOffTorch()
   

Frame Acquiring Methods Details

getFrameFromBuffer

Get the latest frame from the buffer. The boolean value determines whether the fetched frame will be removed from the buffer.

- (DCEFrame*)getFrameFromBuffer:(BOOL)keep;

Parameters

[in] Keep If set to true, the frame will be kept in the video buffer. Otherwise, it will be removed from the video buffer.

Return Value

The latest frame in the video buffer.

Code Snippet

• Objective-C
• Swift

1. dceFrame = [_dce getFrameFromBuffer:true];
   

2. let dceFrame = dce.getFrameFromBuffer()
   

addListener

Add a listener to the CameraEnhancer instance. This method will have no effect if the same listener is already added.

- (void)addListener:(nonnull id<DCEFrameListener>)listener;

Parameters

listener: An object of DCEFrameListener. Its callback method frameOutputCallback will be available for users to make further operations on the captured video frame.

Code Snippet

• Objective-C
• Swift

1. [_dce addListener:self];
   

2. dce.addListener(self)
   

removeListener

Remove a previously added listener from the CameraEnhancer instance. This method will have no effect if there is no listener exists in CameraEnhancer instance.

- (void)removeListener:(nonnull id<DCEFrameListener>)listener;

Parameters

[in] listener The input listener will be removed from the Camera Enhancer instance.

Code Snippet

• Objective-C
• Swift

1. [_dce removeListener:self];
   

2. dce.removeListener(self)
   

takePhoto

Take a photo from the camera and save the image in the memory. The photo will be captured and users can receive the captured photo via photoOutputCallback.

- (void)takePhoto:(nonnull id<DCEPhotoListener>)listener API_AVAILABLE(ios(11.0));

Parameters

[in] listener An instance of DCEPhotoListener.

Code Snippet

• Objective-C
• Swift

1. @interface ViewController ()<DCEPhotoListener>
   - (void)configurationDCE(){
      [_dce takePhoto:self]
   }
   - (void)photoOutputCallback:(NSData *)jpegBytes{
      // Add your code to execute when photo is captured.
   }
   

2. class ViewController: UIViewController, DCEPhotoListener {
      func configurationDCE(){
         dce.takePhoto()
      }
      func photoOutputCallback(_ jpegByte: Data){
         // Add your code to execute when photo is captured.
      }
   }
   

Enhanced Features Methods Details

enableFeatures

Enable camera enhancer features by inputting EnumEnhancerFeatures value.

The EnumEnhancerFeatures members:

- (void)enableFeatures:(EnumEnhancerFeatures)features  error:(NSError * _Nullable * _Nullable)error;

Parameters

[in] enhancerFeatures The combined value of EnumEnhancerFeatures.

Code Snippet

• Objective-C
• Swift

1. [_dce enableFeatures:EnumFRAME_FILTER error: &error];
   

2. try? dce.enableFeatures(EnumEnhancerFeature.EnumFRAME_FILTER.rawValue)
   

Remarks

The enable action will not be approved if the license is invalid. If your input values include the features that have been already enabled, these features will keep the enabled status.

disableFeatures

Disable camera enhancer features by inputting EnumEnhancerFeatures values.

- (void)disableFeatures:(EnumEnhancerFeatures)features;

Parameters

[in] enhancerFeatures The combined value of EnumEnhancerFeatures.

Code Snippet

• Objective-C
• Swift

1. [_dce disableFeatures:EnumFRAME_FILTER];
   

2. dce.disableFeatures(EnumEnhancerFeature.EnumFRAME_FILTER.rawValue)
   

Remarks

You can still disable the features even if the license is invalid. If your input values include the features that are not enabled, these features will keep the disabled status.

isFeatureEnabled

Check whether the input features are enabled.

- (BOOL)isFeatureEnabled:(EnumEnhancerFeatures)features;

Parameters

[in] enhancerFeatures The combined value of EnumEnhancerFeatures.

Return Value

A BOOL value refers to whether all the features you input are enabled.

• True: All the features you input are enabled.
• False: There is at least one feature is not enabled among your input values.

Code Snippet

• Objective-C
• Swift

1. BOOL featureEnabled = [_dce isFeatureEnabled:EnumFRAME_FILTER];
   

2. let featureEnabled = dce.isFeatureEnabled(EnumEnhancerFeature.EnumFRAME_FILTER.rawValue)
   

Remarks

If the features you input are all enabled but don’t cover all the enabled features, this method will still return true.

Advanced Camera Control Methods Details

getFrameRate

Get the current frame rate.

- (NSInteger)getFrameRate;

Return Value

The current frame rate.

Code Snippet

• Objective-C
• Swift

1. NSInteger frameRate = [_dce getFrameRate];
   

2. let frameRate = dce.getFrameRate()
   

setResolution

Input one of the preset resolution value in Enumeration Resolution. The camera enhancer will try to set the resolution to the target value or the closest available value below the target value.

- (Void)setResolution:(Resolution)resolution;

Parameters

[in] resolution One of the int value that preset in Enumeration EnumResolution.

Code Snippet

• Objective-C
• Swift

1. [_dce setResolution:EnumRESOLUTION_1080P];
   

2. dce.setResolution(EnumResolution.EnumRESOLUTION_1080P)
   

getResolution

Get the current resolution.

- (NSString*)getResolution;

Return Value

The size of the current resolution.

Code Snippet

• Objective-C
• Swift

1. NSString* resolution = [_dce getResolution];
   

2. let resolution = dce.getResolution()
   

setZoom

Set the zoom factor. Once setZoom is triggered and approved, the zoom factor of the activated camera will immediately become the input value.

- (Void)setZoom:(CGFloat)factor

Parameters

factor: The target zoom factor.

Code Snippet

• Objective-C
• Swift

1. [_dce setZoom:3.0f];
   

2. dce.setZoom(3.0)
   

getMaxZoomFactor

Get the maximum available zoom factor.

- (CGFloat)getMaxZoomFactor;

Return Value

A CGFloat value that indicates the maximum available zoom factor of the device.

Code Snippet

• Objective-C
• Swift

1. CGFloat maxZoomFactor = [_dce getMaxZoomFactor];
   

2. let maxZoomFactor = dce.getMaxZoomFactor()
   

setFocus

Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position.

- (Void)setFocus:(CGPoint)focusPosition;

Parameters

[in] focusPosition A CGPoint that stores the x and y coordinate of the targeting focus position.

Code Snippet

• Objective-C
• Swift

1. CGPoint focusPoint = {0.4, 0.5};
   [_dce setFocus:focusPoint];
   

2. let focusPoint = CGPoint(x:0.4, y:0.5)
   dce.setFocus(focusPoint)
   

setScanRegion

Specify the scanRegion. The DCEFrames will be cropped according to the scanRegion before they are stored in the video buffer.

- (void)setScanRegion:(RegionDefinition)scanRegion error:(NSError * _Nullable)error;

Parameters

[in] scanRegion Use a iRegionDefinition value to specify the scan region. The parameter will be optimized to the maximum or minimum available value if the input parameter is out of range. For more information, please view iRegionDefinition.

Code Snippet

• Objective-C
• Swift

1. iRegionDefinition* scanRegion = [[iRegionDefinition alloc] init];
   scanRegion.regionTop = 25;
   scanRegion.regionBottom = 75;
   scanRegion.regionLeft = 25;
   scanRegion.regionRight = 75;
   scanRegion.regionMeasuredByPercentage = 1
   [_dce setScanRegion:scanRegion error: &error];
   

2. let scanRegion = iRegionDefinition()
   scanRegion.regionTop = 25
   scanRegion.regionBottom = 75
   scanRegion.regionLeft = 25
   scanRegion.regionRight = 75
   scanRegion.regionMeasuredByPercentage = 1
   try? dce.setScanRegion(scanRegion)
   

Remarks

• The region definition defines the region on the camera view. For each value of the class iRegionDefinition:
  • The regionTop is the distance between the top of the scan region and the top of the video frame.
  • The regionBottom is the distance between the bottom of the scan region and the top of the video frame.
  • The regionLeft is the distance between the left of the scan region and the left of the video frame.
  • The regionRight is the distance between the right of the scan region and the left of the video frame.
• When you trigger setScanRegion, the enhancer feature EF_FAST_MODE will be disabled.
• You will still get the original DCEFrame from FrameOutputCallback and cropped DCEFrame from getFrameFromBuffer. The cropRegion of DCEFrame will be configured based on the scanRegion when setScanRegion is triggered.
• When you trigger setScanRegion, the scanRegionVisible will be set to true automatically. If you don’t want to display the scanRegion on the UI, please set the scanRegionVisible to false manually.

getScanRegion

- (iRegionDefinition) getScanRegion

Return Value

The return value of getScanRegion is always the actual parameter of the scanRegion, which might be different from the user input parameter. If scanRegion is not configured or the method setScanRegion is not approved, the return value will be null.

Code Snippet

• Objective-C
• Swift

1. iRegionDefinition* myScanRegion = [[iRegionDefinition alloc] init];
   myScanRegion = [_dce getScanRegion];
   

2. let scanRegion = iRegionDefinition()
   scanRegion = dce.getScanRegion()
   

scanRegionVisible

Set whether to display the scanRegion on the UI. The default value of the property is false. When the property value is set to true, the scan region will be drawn on the UI. The scanRegion will not be displayed if its value is null

@property (assign, nonatomic) BOOL scanRegionVisible;

updateAdvancedSettingsFromFile

Update the advanced camera controlling and video streaming processing parameters. This method enables you to update settings via a JSON file from the storage.

- (void)updateAdvancedSettings:(NSString*)filePath error:(NSError * _Nullable * _Nullable)error;

Parameters

[in] filePath The file path of the JSON file.

Code Snippet

• Objective-C
• Swift

1. [_dce updateAdvancedSettingsFromFile:@"Put your JSON file path here." error: &error];
   

2. try? dce.updateAdvancedSettingsFromFile("Put your JSON file path here.")
   

Remarks

You might need permission authority to enable the Camera Enhancer to read the file in your mobile storage.

updateAdvancedSettingsFromString

Update the advanced camera controlling and video streaming processing parameters. This method enables you to update settings via a JSON string.

- (void)updateAdvancedSettings:(NSString*)params error:(NSError * _Nullable * _Nullable)error;

Parameters

[in] jsonString A stringified JSON data.

Code Snippet

• Objective-C
• Swift

1. [_dce updateAdvancedSettingsFromString:@"Put your stringified JSON data here." error: &error];
   

2. try? dce.updateAdvancedSettingsFromString("Put your stringified JSON data here.")