Horizon SDK 1.8

* Added extra method in HVTSDK to activate the SDK with extra parameter, like the scale filter frequency (look at HVTScaleFilterFrequencySettingsKey in HVTVars.h) * Added cropRegionTintColor property in HVTView that controls the tint color of the dark area of the crop region.
HorizonCamera · Oct 19, 2016 · 7b2117a · 7b2117a
1 parent 7320db6
commit 7b2117a
Show file tree

Hide file tree

Showing 64 changed files with 485 additions and 96 deletions.
diff --git a/HorizonSDK/HorizonSDK.bundle/HVTCameraController.nib b/HorizonSDK/HorizonSDK.bundle/HVTCameraController.nib
diff --git a/HorizonSDK/HorizonSDK.bundle/HVTCameraPlaybackController.nib b/HorizonSDK/HorizonSDK.bundle/HVTCameraPlaybackController.nib
diff --git a/HorizonSDK/HorizonSDK.bundle/Info.plist b/HorizonSDK/HorizonSDK.bundle/Info.plist
diff --git a/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTSDK.h b/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTSDK.h
@@ -15,24 +15,37 @@
 @interface HVTSDK : NSObject
 
 /**
- *  Returns the singleton HVTSDK reference to use in your application.
- *
- *  Do not initialize the HVTSDK class yourself.
- *
- *  @return The HVTSDK singleton instance reference.
+ Returns the singleton HVTSDK reference to use in your application.
+
+ Do not initialize the HVTSDK class yourself.
+ 
+ @return The HVTSDK singleton instance reference.
  */
 + (HVTSDK*) sharedInstance;
 
 /**
- *  @brief Start the shared HorizonSDK session
- *
- *  This method serves as the entry point to Horizon SDK.  It must be
- *  called before instantiating a new HVTCamera object, preferably in the scope
- *  of application:didFinishLaunchingWithOptions: mthod of your UIApplicationDelegate class.
- *
- *  @param apiKey The API key for this app.
- *  @return YES if the HVTSDK was successfully activated, NO otherwise (with NSInternalInconsistencyException for exception handling)
+ @brief Start the shared HorizonSDK session
+
+ This method serves as the entry point to Horizon SDK.  It must be
+ called before instantiating a new HVTCamera object, preferably in the scope
+ of application:didFinishLaunchingWithOptions: method of your UIApplicationDelegate class.
+ 
+ @param apiKey The API key for this app.
+ @return YES if the HVTSDK was successfully activated, NO otherwise (with NSInternalInconsistencyException for exception handling)
  */
 - (BOOL)activateWithAPIKey:(NSString*)apiKey;
 
-@end
+/**
+ @brief Start the shared HorizonSDK session with extra settings
+ 
+ This method serves as the entry point to Horizon SDK.  It must be
+ called before instantiating a new HVTCamera object, preferably in the scope
+ of application:didFinishLaunchingWithOptions: method of your UIApplicationDelegate class.
+ 
+ @param apiKey The API key for this app.
+ @param settingsDictionary You can control various extra parameters using settings dictionary (@see HVTScaleFilterFrequencySettingsKey)
+ @return YES if the HVTSDK was successfully activated, NO otherwise (with NSInternalInconsistencyException for exception handling)
+ */
+- (BOOL)activateWithAPIKey:(NSString*)apiKey settings:(NSDictionary *)settingsDictionary;
+
+@end
diff --git a/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTVars.h b/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTVars.h
@@ -22,6 +22,19 @@ typedef struct
 // Constant used by NSError to distinguish errors belonging to the Horizon SDK domain
 extern NSString *const HVTErrorDomain;
 
+/**
+ User-provided NSDictionary key for the HVTSDK class method
+ activateWithAPIKey:settings: dictionary argument, which controls
+ the frequency of the low-pass filter that is used internally to smoothen out the change of scale.
+ 
+ Higher values provide smoother result.
+ 
+ The value must be a positive float number.
+ 
+ Default value is 1.8
+ */
+extern NSString *const HVTScaleFilterFrequencySettingsKey;
+
 /**
  Horizon SDK-related error codes
  */
@@ -92,9 +105,19 @@ If recording starts, the current rotation will remain unchanged until recording
  @see HVTLevelerCropMode
  */
 typedef NS_ENUM(NSInteger, HVTLevelerFlexSpeed) {
-    /** The scale speed will be slow. This slows down the zoom effect and produces a smoother result.*/
+    /**
+     The scale speed will be slow. This slows down the zoom effect 
+     and produces a smoother result.
+     
+     A low-pass filter is used internally to smoothen out the change of scale. 
+     
+     You can change its frequency by providing a settings NSDictionary at the HVTSDK class method
+     activateWithAPIKey:settings: using the key HVTScaleFilterFrequencySettingsKey.
+     */
     HVTLevelerFlexSpeedSmooth,
-    /** The scale speed will be more responsive. This results to a faster but more unsteady zoom effect.*/
+    /** 
+     The scale speed will be more responsive. This results to a faster but more unsteady zoom effect.
+     */
     HVTLevelerFlexSpeedResponsive
 };
 

diff --git a/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTView.h b/HorizonSDK/HorizonSDK.framework/Versions/A/Headers/HVTView.h
@@ -63,77 +63,106 @@ typedef NS_ENUM(NSInteger, HVTViewWatermarkPosition) {
 
 /** @name Configuration */
 
-/** Specifies the preview type of the view.
+/** 
+ Specifies the preview type of the view.
  
  When set to `HVTViewTypeNormal`, HUD elements can be displayed depending on the showHUD property.
  
  The default value, `HVTViewTypeNormal` is best suited for most applications.
 
- @see HVTViewType*/
+ @see HVTViewType
+ */
 @property (nonatomic) HVTViewType viewType;
 
-/** Specifies the position of the Horizon watermark on the view.
+/** 
+ Specifies the position of the Horizon watermark on the view.
  
  The default value, `HVTViewWatermarkPositionBottomRight` places the watermark in the bottom right corner of the HVTView.
  
- @see HVTViewWatermarkPosition*/
+ @see HVTViewWatermarkPosition
+ */
 @property (nonatomic) HVTViewWatermarkPosition watermarkPosition;
 
-/** Specifies whether the view is enabled or not.
+/** 
+ Specifies whether the view is enabled or not.
  
  Enabled means that the rendering takes place and disabled is when rendering is not active for this view.
  
  Use this property to manually stop the renderning to a specific view for certain cases (e.g. use in a UICollectionViewCell)
  */
 @property (nonatomic) BOOL enabled;
 
-/** Specifies the active filter for this view.
+/** 
+ Specifies the active filter for this view.
  
  You can use the predefined filters provided by Core Image library or add your own custom CIKernels.
  */
 @property (nonatomic) CIFilter *filter;
 
-/** Specifies whether HUD elements, such as the crop region and corners, are shown.
+/** 
+ Specifies whether HUD elements, such as the crop region and corners, are shown.
  
  This property applies only when viewType is set to `HVTViewTypeNormal`.
  
- The default value is `YES`. */
+ The default value is `YES`. 
+ */
 @property (nonatomic) BOOL showHUD;
 
-/** Specifies how the video preview is displayed within the view's bounds rect.
+/** 
+ Specifies how the video preview is displayed within the view's bounds rect.
  
  A common usage scenario is to toggle the fill mode when the user double taps the view.
  
  The property in animated. 
  
  The default value is `HVTViewFillModeAspectFit`.
- @see HVTViewFillMode*/
+ @see HVTViewFillMode
+ */
 @property (nonatomic) HVTViewFillMode fillMode;
 
-/** Assigns the color to the circle that is being displayed when the user tries to focus in a point of the HVTView.
+/** 
+ Assigns the color to the circle that is being displayed when the user tries to focus in a point of the HVTView.
  
- The default color is white.*/
+ The default color is white
+ .*/
 @property (nonatomic) UIColor *focusViewColor;
 
-/** Assigns the border width to the circle that is being displayed when the user tries to focus in a point of the HVTView.
+/** 
+ Assigns the border width to the circle that is being displayed when the user tries to focus in a point of the HVTView.
  
- The default border width is 1.0*/
+ The default border width is 1.0
+ */
 @property (nonatomic) CGFloat focusViewBorderWidth;
 
-/** Controls if the view will include a double tap gesture to cycle through the different fill modes available.
+/**
+ Sets and returns the tint color for the dark area of the crop region.
+
+ The RGB values of this color will be multiplied with the video. The alpha value is not used. For example set it to [UIColor grayColor] for a dark look.
+ 
+ The default color is (0.5f, 0.5f, 0.5f, 1.0f).
+ */
+@property (nonatomic) UIColor *cropRegionTintColor;
+
+/** 
+ Controls if the view will include a double tap gesture to cycle through the different fill modes available.
  
  The default value is `NO`.
- @see HVTViewFillMode*/
+ @see HVTViewFillMode
+ */
 @property (nonatomic, getter=isDoubleTapToChangeFillModeEnabled) BOOL enablesDoubleTapToChangeFillMode;
 
-/** Controls if the view will include a tap to focus gesture.
+/** 
+ Controls if the view will include a tap to focus gesture.
  
- The default value is `NO`.*/
+ The default value is `NO`.
+ */
 @property (nonatomic, getter=isTapToFocusEnabled) BOOL enablesTapToFocus;
 
-/** Controls if the view will include a long press to lock focus and exposure gesture.
+/** 
+ Controls if the view will include a long press to lock focus and exposure gesture.
  
- The default value is `NO`.*/
+ The default value is `NO`.
+ */
 @property (nonatomic, getter=isLongPressToLockFocusExposureEnabled) BOOL enablesLongPressToLockFocusExposure;
 
-@end
+@end
diff --git a/HorizonSDK/HorizonSDK.framework/Versions/A/HorizonSDK b/HorizonSDK/HorizonSDK.framework/Versions/A/HorizonSDK
diff --git a/docs/Classes/HVTCamera.html b/docs/Classes/HVTCamera.html
@@ -3015,7 +3015,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-04</p>
+						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-19</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>

diff --git a/docs/Classes/HVTCameraController.html b/docs/Classes/HVTCameraController.html
@@ -943,7 +943,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-04</p>
+						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-19</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>

diff --git a/docs/Classes/HVTSDK.html b/docs/Classes/HVTSDK.html
@@ -68,6 +68,8 @@ <h1 id="library-title">
 
 		<option value="//api/name/activateWithAPIKey:">- activateWithAPIKey:</option>
 
+		<option value="//api/name/activateWithAPIKey:settings:">- activateWithAPIKey:settings:</option>
+
 	</optgroup>
 
 
@@ -186,7 +188,7 @@ <h3 class="method-title"><code><a href="#//api/name/activateWithAPIKey:">&ndash;
 
 <p>This method serves as the entry point to Horizon SDK.  It must be
 called before instantiating a new <a href="../Classes/HVTCamera.html">HVTCamera</a> object, preferably in the scope
-of application:didFinishLaunchingWithOptions: mthod of your UIApplicationDelegate class.</p>
+of application:didFinishLaunchingWithOptions: method of your UIApplicationDelegate class.</p>
 			</div>
 
 
@@ -224,6 +226,73 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>
 
 
 
+			<div class="method-subsection declared-in-section">
+				<h4 class="method-subtitle">Declared In</h4>
+				<p><code class="declared-in-ref">HVTSDK.h</code></p>
+			</div>
+
+
+		</div>
+	</div>
+</div><div class="section-method">
+	<a name="//api/name/activateWithAPIKey:settings:" title="activateWithAPIKey:settings:"></a>
+	<h3 class="method-title"><code><a href="#//api/name/activateWithAPIKey:settings:">&ndash;&nbsp;activateWithAPIKey:settings:</a></code>
+</h3>
+
+	<div class="method-info">
+		<div class="pointy-thing"></div>
+
+		<div class="method-info-container">
+
+
+			<div class="method-subsection brief-description">
+				<p>Start the shared HorizonSDK session with extra settings</p>
+
+<p>This method serves as the entry point to Horizon SDK.  It must be
+called before instantiating a new <a href="../Classes/HVTCamera.html">HVTCamera</a> object, preferably in the scope
+of application:didFinishLaunchingWithOptions: method of your UIApplicationDelegate class.</p>
+			</div>
+
+
+
+			<div class="method-subsection method-declaration"><code>- (BOOL)activateWithAPIKey:(NSString *)<em>apiKey</em> settings:(NSDictionary *)<em>settingsDictionary</em></code></div>
+
+
+
+			<div class="method-subsection arguments-section parameters">
+				<h4 class="method-subtitle parameter-title">Parameters</h4>
+				<table class="argument-def parameter-def">
+
+					<tr>
+						<th scope="row" class="argument-name"><code>apiKey</code></th>
+						<td><p>The API key for this app.</p></td>
+					</tr>
+
+					<tr>
+						<th scope="row" class="argument-name"><code>settingsDictionary</code></th>
+						<td><p>You can control various extra parameters using settings dictionary (@see HVTScaleFilterFrequencySettingsKey)</p></td>
+					</tr>
+
+				</table>
+			</div>
+
+
+
+			<div class="method-subsection return">
+				<h4 class="method-subtitle parameter-title">Return Value</h4>
+				<p>YES if the HVTSDK was successfully activated, NO otherwise (with NSInternalInconsistencyException for exception handling)</p>
+			</div>
+
+
+
+
+
+
+
+
+
+
+
 			<div class="method-subsection declared-in-section">
 				<h4 class="method-subtitle">Declared In</h4>
 				<p><code class="declared-in-ref">HVTSDK.h</code></p>
@@ -245,7 +314,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-04</p>
+						<p class="copyright">Copyright &copy; 2016 Horizon Video Technologies Inc. All rights reserved. Updated: 2016-10-19</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>