| Face Engine SDK 5.34.0 A face detection, recognition and tracking engine.

ILicense.h
1 #pragma once
2
3 #include <fsdk/IObject.h>
4 #include <fsdk/FSDKError.h>
5
6 namespace fsdk {
7
8 #ifndef DOXYGEN_SHOULD_SKIP_THIS
9 DECLARE_SMARTPTR(ILicense);
10 #endif
11
15 enum class LicenseFeature : uint32_t {
16 Detection = 1,
17 BestShot = 2,
18 Attributes = 3,
19 Emotions = 4,
20 FaceFeatures = 5,
21 Liveness = 6,
22 Descriptor = 7,
23 DescriptorIndex = 8,
24 LivenessEngine = 9,
25 TrackEngine = 10,
26 HumanDetection = 11,
27 PPEDetection = 17,
28 MobileLiveness = 18,
29 MedicalMaskDetection = 19,
30 ReIdDescriptor = 20,
31 ISOCheck = 21,
32 DeepFakeEstimation = 22,
33 DepthRGBLiveness = 23,
34 FightsEstimation = 24,
35 BodyAttributes = 25,
36 NIRLiveness = 26,
37 DepthLiveness = 27,
38 ImageModification = 28,
39
40 // extern features
41 VirtualCameraChecker = 500
42 };
43
47 struct Fingerprint {
49 constexpr static uint16_t max_size = 65;
50
54 constexpr const char* to_string() const {
55 return data;
56 }
57
59 char data[max_size];
60 };
61
65 struct AID {
67 constexpr static uint16_t max_size = 40;
68
72 constexpr const char* to_string() const {
73 return data;
74 }
75
77 char data[max_size];
78 };
79
84 struct ILicense : IRefCounted {
92 virtual ResultValue<FSDKError, bool> checkFeatureId(LicenseFeature feature) const noexcept = 0;
93
101 virtual ResultValue<FSDKError, bool> isActivated() const noexcept = 0;
102
110 virtual Result<FSDKError> loadFromFile(const char* path, const ISettingsProvider* settings) noexcept = 0;
111
119 virtual Result<FSDKError> saveToFile(const char* path) const noexcept = 0;
120
129 virtual ResultValue<FSDKError, uint32_t> getExpirationDate(LicenseFeature feature) const noexcept = 0;
130
137 virtual Result<FSDKError> getLicenseType(int& licenseType) const noexcept = 0;
138
146 virtual ResultValue<FSDKError, AID> getAID() const noexcept = 0;
147 };
148
149 } // namespace fsdk
fsdk::AID::data
char data[max_size]
The internal buffer to store the AID data.
Definition: ILicense.h:77
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:70
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::Fingerprint::data
char data[max_size]
The internal buffer to store the fingerprint data.
Definition: ILicense.h:59
fsdk::ILicense::getLicenseType
virtual Result< FSDKError > getLicenseType(int &licenseType) const noexcept=0
Gets license type.
fsdk::ILicense::saveToFile
virtual Result< FSDKError > saveToFile(const char *path) const noexcept=0
Saves license as raw format to the file. This file could be used in the next run of the application...
fsdk::AID::max_size
static constexpr uint16_t max_size
< The maximum size of the AID data
Definition: ILicense.h:67
fsdk::AID
Activation identifier structure.
Definition: ILicense.h:65
fsdk::AID::to_string
constexpr const char * to_string() const
Returns the AID as a string with zero end.
Definition: ILicense.h:72
IObject.h
Object system types and interfaces.
fsdk::ILicense
License objects interface.
Definition: ILicense.h:84
FSDKError.h
Common SDK error codes.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::ILicense::getExpirationDate
virtual ResultValue< FSDKError, uint32_t > getExpirationDate(LicenseFeature feature) const noexcept=0
Gets license expiration date.
fsdk::LicenseFeature
LicenseFeature
License features.
Definition: ILicense.h:15
fsdk::ResultValue
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:21
fsdk::ILicense::checkFeatureId
virtual ResultValue< FSDKError, bool > checkFeatureId(LicenseFeature feature) const noexcept=0
Checks if the feature with featureId is available in this license.
fsdk::FightsEstimation
FightsEstimation result structure. This structure will return from the IFightsEstimatorContext::getRe...
Definition: IFightsEstimator.h:29
fsdk::ILicense::isActivated
virtual ResultValue< FSDKError, bool > isActivated() const noexcept=0
Checks if current license object is activated and could be used by FaceEngine.
fsdk::Fingerprint
Fingreprint structure.
Definition: ILicense.h:47
fsdk::Fingerprint::to_string
constexpr const char * to_string() const
Returns the fingerprint as a string with zero end.
Definition: ILicense.h:54
fsdk::Detection
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::ILicense::loadFromFile
virtual Result< FSDKError > loadFromFile(const char *path, const ISettingsProvider *settings) noexcept=0
Loads license from file.
fsdk::Fingerprint::max_size
static constexpr uint16_t max_size
< The maximum size of the fingerprint data
Definition: ILicense.h:49
fsdk::ILicense::getAID
virtual ResultValue< FSDKError, AID > getAID() const noexcept=0
Gets activation identifier.
fsdk::ISettingsProvider
SDK settings provider interface.
Definition: ISettingsProvider.h:32