Atalasoft MobileImage API Reference
Instance Methods | Class Methods | Properties | List of all members
kfxKUILicenseCaptureControl Class Reference

This class renders the camera preview to the screen and searches for an SDK license key in a QR code. More...

#import <kfxKUILicenseCaptureControl.h>

Inheritance diagram for kfxKUILicenseCaptureControl:

Instance Methods

(void) - readLicense
 Reads an SDK license from the camera preview. More...
 

Class Methods

(void) + initializeControl
 This message initializes the control and must be sent to the class before it is used. More...
 

Properties

IBOutlet id< kfxKUILicenseCaptureControlDelegatedelegate
 A delegate to receive messages from the control. More...
 
CGFloat viewfinderPaddingPercent
 The padding percent required between the viewfinder and camera preview frame. More...
 
UIColor * outerViewfinderColor
 Outer viewfinder color. More...
 
kfxKUICaptureMessageuserInstruction
 An instructional text box that is displayed to the user while trying to capture an SDK license. More...
 

Detailed Description

This class renders the camera preview to the screen and searches for an SDK license key in a QR code.

This class is responsible for rendering the camera preview and provides guidance to capture the SDK license from a QR code. Once the view has been asked to read an SDK license, it will search continuously until one is found.

Method Documentation

+ (void) initializeControl

This message initializes the control and must be sent to the class before it is used.

This message initializes the control for use and must be sent to the class before it is used. It is ok to send the message more than once. A common way to do this is in your UIViewController subclasses initialize or init methods.

- (void) readLicense

Reads an SDK license from the camera preview.

This call returns immediately and starts asynchronously searching for an SDK license. The search will continue indefinitely until an SDK license is found.

Once an SDK license is positively read, the delegate will receive a licenseCaptureControl:errorCode:daysRemaining:license: message.

If license string is valid it will be set into SDK for licensing.

Property Documentation

- (IBOutlet id<kfxKUILicenseCaptureControlDelegate>) delegate
readwritenonatomicstrong

A delegate to receive messages from the control.

A delegate that will be notified with found SDK license.

See also
kfxKUILicenseCaptureControlDelegate
- (UIColor*) outerViewfinderColor
readwritenonatomicstrong

Outer viewfinder color.

Specifies the color that will be used for the outer viewfinder background.

The default color is transparent grey.

See also
viewfinderPaddingPercent
- (kfxKUICaptureMessage*) userInstruction
readwritenonatomicstrong

An instructional text box that is displayed to the user while trying to capture an SDK license.

The following kfxKUICaptureMessage properties are not supported for this message:

  • messageIcons
  • backGround

Default configuration:

  • message: "Fill viewable area with license in QR Code format"
  • font: HelveticaNeue with size 23. If text can't be fit in the message box tail truncation will be used.
  • text color: white
  • backGroundColor: clear
  • position: centered inside viewfinder
  • size: width is equal to the viewfinder width and height is 100 points
  • orientation: portrait
See also
kfxKUICaptureMessage
- (CGFloat) viewfinderPaddingPercent
readwritenonatomicassign

The padding percent required between the viewfinder and camera preview frame.

This value determines how much percentage the viewfinder needs to be positioned inside the camera preview frame. Valid values are [0-50].

The default value is 10.

See also
outerViewfinderColor

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.