ilabs-flir 1.0.7 → 2.0.1

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRRemoteControl.h

@@ -0,0 +1,393 @@
+//
+//  FLIRRemoteControl.h
+//  FLIR Thermal SDK
+//
+//  Created on 2018-09-05.
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+//  Camera remote control. Can read, manipulate and listen for events from a Camera.
+//
+
+#pragma once
+
+#import <Foundation/Foundation.h>
+#import "FLIRIdentity.h"
+#import "FLIRBattery.h"
+#import "FLIRCalibration.h"
+#import "FLIRFusionController.h"
+#import "FLIRCameraImport.h"
+#import "FLIRThermalValue.h"
+
+/**
+ *  Path to a stored image (or IR+visual pair of images) on a camera.
+ */
+@interface FLIRStoredImage : NSObject
+/** Reference to the thermalimage */
+@property (nonatomic, nonnull, readwrite) FLIRFileReference *thermalImage;
+/** Reference to the visualimage. */
+@property (nonatomic, nullable, readwrite) FLIRFileReference *visualImage;
+@end
+
+
+/**
+ *  Describes a state of a FLIR camera.
+ */
+typedef NS_ENUM(NSUInteger, FLIRCameraState)
+{
+    /** Camera is not ready */
+    NOT_READY,
+    /** Camera is cooling down */
+    COOLING,
+    /** Camera is ready */
+    READY
+};
+
+/**
+ *  Progress status for firmware update. (Internal use only.)
+ */
+typedef NS_ENUM(NSUInteger, FLIRFirmwareUpdateStatus)
+{
+    /// no firmware update is started
+    US_noUpdate,
+    /// information on firmware update progress
+    US_info,
+    /// the firmware update failed, camera will be rebooted
+    US_failure,
+    /// the firmware update was successful, camera will be rebooted
+    US_success,
+    /// the firmware update is ongoing, camera is rebooting
+    US_rebooting,
+    /// the firmware update starts writing a package
+    US_startWritingPackage,
+    /// the firmware update has written a package
+    US_doneWritingPackage,
+    /// there was a failure writing a package
+    US_failureWritingPackage,
+    /// the firmware update starts
+    US_startExecutingUpdate,
+    /// the firmware update is done
+    US_doneExecutingUpdate,
+    /// the firmware update cannot start, since the camera is in normal mode instead of upgrade mode
+    US_failureInvalidMode,
+    /// the package write failed, retry
+    US_retryWritingPackage
+};
+
+/// Time format for time display on camera
+typedef NS_ENUM(NSUInteger, FLIRTimeDisplayFormat)
+{
+    /// 12h (e.g. 1.00 pm)
+    TF_t12H,
+    /// 24h (e.g. 13.00)
+    TF_t24H
+};
+
+/// Date format for date display on camera
+typedef NS_ENUM(NSUInteger, FLIRDateDisplayFormat)
+{
+    /// YYYY-MM-DD
+    DF_ymd,
+    /// MM/DD/YYYY
+    DF_mdy,
+    /// DD/MM/YYYY
+    DF_dmy
+};
+
+/// Operating modes used by cameras for firefighting
+typedef NS_ENUM(NSUInteger, FLIRFireCameraMode)
+{
+    FLIRFireCameraMode_basic,           ///< Default mode for firefighting. Basic mode on K45, K55. TI Basic NFPA on K65.
+    FLIRFireCameraMode_search,         ///< Search mode.
+    FLIRFireCameraMode_detection,   ///< Detection mode.
+    FLIRFireCameraMode_fire,           ///< Fire mode. Similar to Basic/NFPA mode but with a higher threshold for heat colorization.
+    FLIRFireCameraMode_whiteHot,     ///< White hot mode.
+};
+
+@interface FLIRFireCameraModeObject : NSObject
+@property (nonatomic, assign) FLIRFireCameraMode mode;
+@end
+
+@interface FLIRFireCameraTemperatureRange : NSObject
+@property (nonatomic, assign) NSInteger minKelvin;
+@property (nonatomic, assign) NSInteger maxKelvin;
+@property (nonatomic, assign) BOOL isAuto;
+@end
+
+@interface FLIRFireCameraModeController : NSObject
+- (BOOL)getAvailable;
+- (BOOL)setAvailable:(BOOL)visible error:(out NSError * _Nullable * _Nullable)error;
+- (BOOL)getReadOnly;
+- (FLIRFireCameraTemperatureRange * _Nullable)getTemperatureRange:(out NSError * _Nullable * _Nullable)error;
+@end
+
+/// GUI HotSpot shapes used by cameras for firefighting.
+typedef NS_ENUM(NSUInteger, FLIRHotSpotShape)
+{
+    FLIRHotSpotShape_disabled,       ///< Disabled.
+    FLIRHotSpotShape_nfpa,           ///< NFPA/basic mode style.
+    FLIRHotSpotShape_crosshair       ///< Crosshair style.
+};
+
+typedef NS_ENUM(NSUInteger, FLIRSingleTriggerBehaviour)
+{
+    FLIRSingleTriggerBehaviour_save,           ///< save a still image
+    FLIRSingleTriggerBehaviour_freeze,         ///< freeze image
+    FLIRSingleTriggerBehaviour_none,           ///< no effect
+    FLIRSingleTriggerBehaviour_record           ///< record video
+};
+
+@interface FLIRDualTriggerBehaviour : NSObject
+@property (nonatomic, assign) FLIRSingleTriggerBehaviour shortPress;
+@property (nonatomic, assign) FLIRSingleTriggerBehaviour longPress;
+@end
+
+/**
+ *  Internal interface for firmware update of FLIR One
+ */
+@interface FLIRFirmwareUpdate : NSObject
+@end
+
+/**
+ *  Video recorder for network cameras
+ */
+@interface FLIRVideoRecorder : NSObject
+- (BOOL)start:(out NSError * _Nullable *_Nullable)error;
+- (BOOL)stop:(out NSError * _Nullable *_Nullable)error;
+
+@property (nonatomic, readonly) BOOL isRecording;
+
+- (BOOL)subscribeVideoRecorder:(out NSError * _Nullable *_Nullable)error;
+- (void)unsubscribeVideoRecorder;
+
+@end
+
+/**
+ * Controller for general camera settings
+ */
+@interface FLIRCameraUISettingsController : NSObject
+
+- (TemperatureUnit)getTemperatureUnit;
+- (BOOL)setTemperatureUnit:(TemperatureUnit)unit error:(out NSError * _Nullable * _Nullable)error;
+- (FLIRDateDisplayFormat)getDateDisplayFormat;
+- (BOOL)setDateDisplayFormat:(FLIRDateDisplayFormat)format error:(out NSError * _Nullable * _Nullable)error;
+- (FLIRTimeDisplayFormat)getTimeDisplayFormat;
+- (BOOL)setTimeDisplayFormat:(FLIRTimeDisplayFormat)format error:(out NSError * _Nullable * _Nullable)error;
+
+@end
+
+@interface FLIRFireCameraController : NSObject
+
+- (FLIRFireCameraMode)getCurrentMode;
+- (BOOL)setCurrentMode:(FLIRFireCameraMode)mode error:(out NSError * _Nullable * _Nullable)error;
+- (NSArray<FLIRFireCameraModeObject *> *_Nullable)getAllModes:(out NSError * _Nullable * _Nullable)error;
+- (NSArray<FLIRFireCameraModeObject *> *_Nullable)getAvailableModes:(out NSError * _Nullable * _Nullable)error;
+
+- (FLIRHotSpotShape)getHotSpotShape;
+- (BOOL)setHotSpotShape:(FLIRHotSpotShape)shape error:(out NSError * _Nullable * _Nullable)error;
+
+- (BOOL)getShowTemperatureBar;
+- (BOOL)setShowTemperatureBar:(BOOL)show error:(out NSError * _Nullable * _Nullable)error;
+- (BOOL)getShowReferenceBar;
+- (BOOL)setShowReferenceBar:(BOOL)show error:(out NSError * _Nullable * _Nullable)error;
+- (BOOL)getShowDigitalReadout;
+- (BOOL)setShowDigitalReadout:(BOOL)show error:(out NSError * _Nullable * _Nullable)error;
+
+- (FLIRDualTriggerBehaviour *_Nullable)getDualTriggerBehaviour:(out NSError * _Nullable *_Nullable)error;
+- (BOOL)setDualTriggerBehaviour:(FLIRDualTriggerBehaviour *_Nonnull)behaviour error:(out NSError * _Nullable *_Nullable)error;
+- (NSArray<FLIRDualTriggerBehaviour *> *_Nullable)getAvailableDualTriggerBehaviours:(out NSError * _Nullable *_Nullable)error;
+
+- (BOOL)getBlackBox;
+- (BOOL)setBlackBox:(BOOL)blackBox error:(out NSError * _Nullable * _Nullable)error;
+
+- (FLIRFireCameraModeController *_Nullable)getFireCameraModeController:(FLIRFireCameraMode)mode error:(out NSError * _Nullable * _Nullable)error;
+
+- (BOOL)getAllowChanges;
+- (BOOL)subscribeAllowChanges:(out NSError * _Nullable * _Nullable)error;
+- (void)unsubscribeAllowChanges;
+- (BOOL)resetParameters:(out NSError * _Nullable * _Nullable)error;
+
+@end
+
+/**
+ *  Camera image storage control interface.
+ */
+@interface FLIRStorage : NSObject
+
+/**
+* Get the latest image that was stored in the camera.
+* This property will be updated when the file is completely written to storage,
+* so there may be some delay from when the picture is taken till the property is updated.
+* Note: this call is blocking.
+*/
+-(nullable FLIRStoredImage *) getLastStoredImage:(out NSError * _Nullable *_Nullable)error;
+
+/** Subscribes for camera last stored image notifications. */
+-(BOOL) subscribeLastStoredImage: (out NSError * _Nullable *_Nullable)error;
+/** Revokes subscription for last stored image. */
+-(void) unsubscribeLastStoredImage;
+
+
+/** Check if camera has snapshot capability */
+- (BOOL)snapshotIsAvailable;
+
+/**  Request camera to store an image into the  image storage and return it.
+ */
+- (FLIRStoredImage * _Nullable)snapshot:(out NSError * _Nullable * _Nullable)error;
+
+@end
+
+/**
+ *  Delegate to return events from a connectad camera.
+ */
+@protocol FLIRRemoteDelegate <NSObject>
+
+@optional
+
+#pragma mark - Battery
+/** Called when battery charging state changes. */
+-(void)ChargingStateChanged:(FLIRChargingState) state;
+/** Called when remaining battery power changes. */
+-(void)PercentageChanged:(int) percent;
+
+#pragma mark - Calibration
+/** Called when a NUC state changes. */
+-(void)CalibrationStateChanged:(BOOL) isActive;
+/** Called when a NUC state changes, with the NUC state as parameter */
+- (void)nucStateChanged: (FLIRNucState)state;
+/** Called when   shutter state changes */
+- (void)shutterStateChanged: (FLIRShutterState)state;
+
+#pragma mark - Storage
+/** Called when new image was taken on the camera. */
+-(void)lastStoredImageChanged:(FLIRStoredImage *_Nonnull) laststore;
+
+/** Called when state is changing, if subscribing */
+- (void)cameraStateChanged: (FLIRCameraState)newState;
+
+/** Called when cameraInformation is changing, if subscribing */
+- (void)cameraInformationChanged: (FLIRCameraInformation*_Nonnull)newInformation;
+
+/** Called when laserOn is changing, if subscribing */
+- (void)cameraIsLaserOnChanged: (BOOL)newIsLaserOn;
+
+#pragma mark - TemperatureRange
+/** Called when selected temperature range changes, if subscribing */
+- (void)selectedTemperatureRangeIndexChanged: (int)index;
+
+#pragma mark - FusionController
+/** Called when fusion activeChannel is changing, if subscribing */
+- (void)activeChannelChanged: (FLIRChannelType)newActiveChannel;
+
+#pragma mark - ScaleController
+/** Called when scale controller auto adjust is chaning, if subscribing */
+- (void)autoAdjustChanged: (BOOL)autoAdjust;
+
+/** Called when status changes in an ongoing firmware update */
+-(void)updateStatusChanged:(FLIRFirmwareUpdateStatus) status;
+
+#pragma mark - VideoRecorder
+/** Called when recording has started or stopped */
+- (void)videoRecorderChanged:(BOOL)isRecording;
+
+#pragma mark - FireCameraController
+/// Called when allowChanges is changed.
+- (void)allowChangesChanged:(BOOL)allowChanges;
+
+
+@end
+
+@class FLIRTemperatureRange;
+@class FLIRSystem;
+@class FLIRFocus;
+@class FLIRPaletteController;
+@class FLIRFusionController;
+@class FLIRMeasurementsController;
+@class FLIRScaleController;
+@class FLIROverlayController;
+
+/**
+ *  Camera remote control. Can read, manipulate and listen on events from a Camera.
+ */
+@interface FLIRRemoteControl : NSObject
+
+/**
+ *  A delegate to handle the events.
+ */
+@property (nonatomic, assign, nullable) id<FLIRRemoteDelegate> delegate;
+
+/**
+ *  Fetch information about that device.
+ *
+ *  @note This is a synchronous call to the camera, which blocks until the result is retrieved or an error occurs.
+ *  @param error Out parameter filled with an error object on failure, or nil on success.
+ *  @return The result object on success, or nil on failure.
+ */
+-(nullable FLIRCameraInformation*)getCameraInformation:(out NSError * _Nullable * _Nullable)error;
+
+/** subscribe to changes on camera information, delegate will be called when camera information changes */
+- (BOOL)subscribeCameraInformation: (out NSError * _Nullable *_Nullable)error;
+
+/**
+ * Get the Battery interface to monitor camera battery status.
+ *
+ * @return Battery object if it's available, or nil if the Camera model has no battery support.
+ */
+-(nullable FLIRBattery *) getBattery;
+
+/**
+ * Get the camera calibration control interface.
+ *
+ * @return Calibration object if it's available, or nil if the Camera model has no calibration support.
+ */
+-(FLIRCalibration* _Nullable) getCalibration;
+
+/**
+ * Get the Storage interface to interact with camera storage (i.e. internal storage or SD card).
+ *
+ * @return Storage object if it's available, or nil if the Camera model has no storage support.
+ */
+-(FLIRStorage* _Nullable) getStorage;
+
+/**
+ * Check if the camera is ready for connecting a stream.
+ */
+- (FLIRCameraState)getCameraReady;
+
+/** subscribe to changes on camera state, delegate will be called when camera state changes */
+- (BOOL)subscribeCameraState: (out NSError * _Nullable *_Nullable)error;
+
+/** Check if the laser is on */
+- (BOOL)getLaserOn;
+/** turn on or of the laser */
+- (BOOL)setLaserOn: (BOOL)laserOn error: (out NSError * _Nullable *_Nullable)error;
+
+/** subscribe to changes on laser on, delegate will be called when laser on changes */
+- (BOOL)subscribeIsLaserOn: (out NSError * _Nullable *_Nullable)error;
+/** unsubscribe to changes on laser on */
+- (void)unsubscribeIsLaserOn;
+
+/** get the temperature range interface */
+- (FLIRTemperatureRange * _Nullable)getTemperatureRange;
+/** get remote system parameters interface */
+- (FLIRSystem* _Nullable)getSystem;
+/** get remote focus parameters interface */
+- (FLIRFocus* _Nullable)getFocus;
+/** get remote palette controller interface */
+- (FLIRPaletteController * _Nullable)getPaletteController;
+/** get remote fusion controller interface */
+- (FLIRFusionController * _Nullable)getFusionController;
+/** get remote measurements controller interface */
+- (FLIRMeasurementsController * _Nullable)getMeasurementsController;
+/** get the scale controller interface */
+- (FLIRScaleController * _Nullable)getScaleController;
+/** get the  overlay controller interface */
+- (FLIROverlayController * _Nullable)getOverlayController;
+/** get firmware update (only for internal use) */
+- (FLIRFirmwareUpdate * _Nullable)getFirmwareUpdate;
+/** get video recorder */
+- (FLIRVideoRecorder * _Nullable)getVideoRecorder;
+/** get camera settings controller */
+- (FLIRCameraUISettingsController * _Nullable)getCameraUISettingsController;
+/// get fire camera controller
+- (FLIRFireCameraController * _Nullable)getFireCameraController;
+@end

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRRenderer.h

@@ -0,0 +1,35 @@
+//
+//  FLIRRenderer.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-12.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+#import <UIKit/UIKit.h>
+
+/**
+ *  Class for rendering images.
+ */
+@protocol FLIRRenderer
+
+/**
+ *  Get "rendered result"
+ *
+ *  Fetch the rendered image from the renderer. This returns a deep copy of the image.
+ *  @return Returns an UIImage, or nil if update has not been called previously or no source image was available yet.
+ */
+- (UIImage * _Nullable)getImage;
+
+/**
+ *  Execute renderer
+ *
+ *  Polls image data from the source (e.g. a @ref FLIRStream or a @ref FLIRThermalImage), then performs image processing
+ *  Result could be stored in a UIImage or rendered directly to screen, depending on configuration.
+ *  @return true if update is succesfull, otherwise the error is set
+ */
+- (BOOL)update:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+@end

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRRendererImpl.h

@@ -0,0 +1,17 @@
+//
+//  FLIRRendererImpl.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-11-01.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#import "FLIRRenderer.h"
+
+/**
+ *  Class implementing FLIRRenderer, for internal use only
+ */
+@interface FLIRRendererImpl : NSObject<FLIRRenderer>
+
+@end
+

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRScale.h

@@ -0,0 +1,99 @@
+//
+//  FLIRScale.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+#import "FLIRThermalValue.h"
+#import "FLIRPalette.h"
+
+/**
+ *  Defines an image's linear scale object and basic scale's parameters.
+ *  The scale defines the way the Palette is applied to the ThermalImage.
+ *  Scale is an interval of the temperature, where colors from a selected Palette is applied.
+ *  The available temperature's range is defined by the ThermalImage.
+ *  Scale cannot be created directly, it should always be obtained from ThermalImage.
+ *  To do so, the ThermalImage.getScale() method should be called.
+ */
+@interface FLIRScale : NSObject
+/**  
+ *   Sets the minimum and maximum scale values.
+ *
+ *   @param min  The minimum scale value.
+ *   @param max  The maximum scale value.
+ */
+- (void)setRangeWithMin:(FLIRThermalValue * _Nonnull)min andMax:(FLIRThermalValue * _Nonnull) max;
+
+/** 
+ *   Sets the scale automatically based on the min and max scale values.
+ *
+ *   @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (void)setAutoAdjustEnabled:(BOOL)enabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");;
+
+/** 
+ *  Gets the current minimum scale value.
+ *  @return The min scale value.
+ */
+- (FLIRThermalValue * _Nonnull)getRangeMin;
+
+/** 
+ *  Gets the current maximum scale value.
+ *  @return The max scale value
+ */
+- (FLIRThermalValue *  _Nonnull)getRangeMax;
+
+/** 
+ *  Gets the thermal scale image.
+ *
+ *  @return An UIImage representing the thermal scale.
+ *
+ *  @note This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (UIImage * _Nullable)getImage DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
+
+/**
+ *  Gets the thermal scale image.
+ *
+ *  @param palette the pallete
+ *  
+ *  @return An UIImage representing the full thermal range scale.
+ *
+ *  @note This feature will likely be removed in upcoming release.
+ */
+
++ (UIImage * _Nullable)getFixedFullRangeScaleImage:(FLIRPalette * _Nonnull) palette DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");;
+
+/**
+ *  Gets the thermal scale image from current palette.
+ *
+ *  @return An UIImage representing the full thermal range scale.
+ *
+ *  @note This feature will likely be removed in upcoming release.
+ */
+
+- (UIImage * _Nullable)getFixedFullRangeScaleImage DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");
+
+
+/**
+ *  Gets auto adjust setting.
+ *
+ *  @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (BOOL)isAutoAdjustEnabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
+
+/**
+ *  Sets the maximum range, where colors defined by the Palette are applied to the ThermalImage.
+ *  @Deprecated Setting max value may affect min value, use setRangeWithMin:andMax:
+ */
+- (void)setRangeMax:(FLIRThermalValue * _Nonnull)max;
+
+/**
+ *  Sets the minimum range, where colors defined by the Palette are applied to the ThermalImage.
+ *  @Deprecated Setting min value may affect max value, use setRangeWithMin:andMax:
+ */
+- (void)setRangeMin:(FLIRThermalValue * _Nonnull)min;
+
+@end

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRScaleController.h

@@ -0,0 +1,44 @@
+//
+//  FLIRScaleController.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2020-09-14.
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+@class FLIRRange;
+
+/**
+* Camera scale controller interface.
+*/
+
+@interface FLIRScaleController : NSObject
+
+/** check if auto adjust is available */
+- (BOOL)autoAdjustAvailable;
+/**
+ * Get auto adjust mode. Defines the adjust mode of the temperature scale on the live screen on the camera.
+ * Auto mode (true value): In this mode, the camera is continuously auto-adjusted for the best image brightness and contrast.
+ * Manual mode (false value): This mode allows manual adjustments of the temperature span and the temperature level.
+ */
+- (BOOL)getAutoAdjust;
+/** Set auto adjust mode */
+- (BOOL)setAutoAdjust:(BOOL)autoAdjust error: (out NSError * _Nullable * _Nullable)error;
+/** subscribe to changes of auto adjust mode */
+- (BOOL)subscribeAutoAdjust:(out NSError * _Nullable * _Nullable)error;
+/** unsubscribe to changes of auto adjust mode */
+- (void)unsubscribeAutoAdjust;
+/** check if scale active mode is available */
+- (BOOL)activeAvailable;
+/** get active mode */
+- (BOOL)getActive;
+/** Enables/disables the scale active mode.*/
+- (BOOL)setActive:(BOOL)active error: (out NSError * _Nullable * _Nullable)error;
+/** get range for scale */
+- (FLIRRange *_Nullable)getRange;
+/** set range for scale */
+- (BOOL)setRange:(FLIRRange *_Nonnull)range error:(out NSError * _Nullable * _Nullable)error;
+
+@end

package/ios/Flir/Frameworks/ThermalSDK.xcframework/ios-arm64/ThermalSDK.framework/Headers/FLIRStream.h

@@ -0,0 +1,109 @@
+//
+//  FLIRStream.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-11.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Delegate for streaming
+ */
+
+@protocol FLIRStreamDelegate <NSObject>
+
+/**
+ *  Called when an error occurs in streaming
+ */
+- (void)onError:(NSError *)error;
+
+/**
+ *  Called when an image is available on the stream
+ */
+- (void)onImageReceived;
+
+@end
+
+/**
+ *  Camera stream class.
+ *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
+ */
+@interface FLIRStream : NSObject
+
+/**
+ *  Delegate with callbacks
+ */
+@property (nonatomic, strong, nullable) id<FLIRStreamDelegate> delegate;
+
+/**
+ *  True if the stream contains both thermal and visual data
+ */
+@property (nonatomic, readonly) BOOL isDual;
+
+/**
+ *  Width and height of the IR data for each frame
+ *  (Zero If no IR data is available)
+ */
+@property (nonatomic, readonly) CGSize irSize;
+
+/**
+ *  Width and height of the visual data for each frame
+ *  (Zero If no visual data is available)
+ */
+@property (nonatomic, readonly) CGSize visualSize;
+
+/**
+ *  True if the stream contains readiometric data
+ */
+@property (nonatomic, readonly) BOOL isThermal;
+
+/**
+ *  True if the stream is active and streaming
+ */
+@property (nonatomic, readonly) BOOL isStreaming;
+
+/**
+ *  Start frame grabbing on the provided stream.
+ *
+ *  Starts the frame grabbing. When a new frame is available the delegate method onImageRecieved will be called.
+ *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
+ *  @param error  The error if start returns false
+ *  @return returns false if not able to start stream
+ */
+- (BOOL)start:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+/**
+ *  Stop frame grabbing on the stream.
+ */
+- (void)stop;
+
+/**
+ * Set the camera's streamed frame rate.<br />
+ * Note: Some cameras will not change frame rate while streaming.
+ *
+ * @param hz Frames per second, must be in between getMinFrameRate and getMaxFrameRate, inclusive
+ */
+- (BOOL)setFrameRate:(double)hertz error:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+/**
+ * Get the camera's streamed frame rate. If the frame rate cannot be fetched, zero is returned.
+ */
+- (double)getFrameRate;
+
+/**
+ * Get the lowest possible frame rate for this camera stream.
+ */
+- (double)getMinFrameRate;
+
+/**
+ * Get the highest possible frame rate for this camera stream. If the frame rate cannot be fetched, zero is returned.
+ */
+- (double)getMaxFrameRate;
+
+@end
+
+NS_ASSUME_NONNULL_END