The markdown parsing is broken/disabled for release notes. Sorry about that, I'm chasing the source of a crash that's been bringing this website down for the last couple of days.
This is a major update to the Sightic Analytics SDK. Changes include:
* Redesigned user experience:
* Contemporary interface design.
* Improved user feedback in the alignment and test loop.
* A complete overhaul of the public API surface.
Please refer to the [documentation](https://sighticanalytics.github.io/sightic-sdk-ios/documentation/sighticanalytics/) for more details.
New case `notfollowingthedot` in enum `SighticRecordingError` which is triggered if the app user does not follow the dot good enough during the test. The purpose is to give the host app the possibility to inform the user that they must follow the dot better with their eyes while doing the test.
In previous releases the recording would be sent to the Sightic backend despite the user not following the dot with their eyes resulting in a positive result, i.e. user is impaired. The goal of this change is to lower the number of false positives.
- We allow a max distance to face of 35 cm instead of 30 cm during the alignment.
- We allow a max distance to face of 45 cm instead of 40 cm during the test.
Bug fixes.
- In the face alignment view, the vignette now only appears if the ambient light intensity is low.
- In the face alignment view, the the static face is displayed even when the user's face is not being tracked.
* Use red instead of white face mesh during alignment of app user face.
* Add new flag `includeFakeTest` to `SighticInferenceView`.
* `includeFakeTest` states whether to show a moving dot forming a circle in the lower part of the screen at the beginning of the test sequence. The purpose is to make the app user aware of that the test has started. This part of the test sequence is not recorded. The flag is optional with default value set to false.
* Remove landscape mode check. This check triggered when phone was in portrait mode on some occasions during testing. We will probably reintroduce this check in a later version of the SDK.
* Relax eye open requirement during test but make it stricter during alignment.
* Background. The SDK requires the app user eyes to be opened during the test. Sometimes the SDK complains about eyes not opened even though app user perceives their eyes to be open. We relax the requirement slightly during the test but also make it a bit stricter during the alignment.
* `SighticStatus` enum has a new case named `fakeTest`.
Make the white static face mesh in alignment view slightly larger to entice the app user to move the phone closer to their face.
- Adds public and customizable `SighticInstructionView` for integrating test instruction graphics into any other view.
- Built with iOS 14 as minimum deployment target. This means it is possible for an app targeting iOS 14 to link with the Sightic SDK framework, but most exposed functionality still require iOS 15.
- Adds the following cases to `SighticRecordingError`:
- `noCameraPermission` indicating that the user has not granted camera permission
- `deviceStationary` indicating that the device was likely not held in hand
- Adds the following case to `SighticAlignmentStatus`:
- `notPortraitOrientation` indicating that the user is not using their device in portrait orientation
- Changes all cases in `SighticHeadTilt` to follow Swift camelCase standard
- Adds the following property to the `SighticStrings` protocol:
- `alignRotateToPortrait` telling the user to hold the device in upright orientation
- Fixes to dark mode appearance
- Adds a white "vignette" around the edge of the display during the alignment phase, to improve performance in poorly lit environments
- Adds a check during test to ensure the user is not talking, and if so, fails the test with status `talking`
- Changes the screens in the instruction view
- Adds an instruction screen telling the user not to talk during the test
- Removes the instruction screen telling the user to keep their head inside a circle on the screen
- Removes the instruction screen telling the user to hold the phone within a maximum distance
- Changes the `SighticStrings` protocol, by
- adding:
- `instructionButtonNext`
- `instructionButtonStart`
- `instructionDoNotTalk`
- and removing:
- `instructionDistanceFromFaceToPhone`
- `instructionFaceInsideCircle`
- Adds the following cases to `SighticRecordingError`:
- `fpsLowTempHigh` indicating that the phone is too warm to perform the test
- `talking` indicating that the user was talking during the test
- Moves the API for sending feedback from `SighticInferenceRecording` to `SighticInference`
- Removes the API `SighticVersion.sdkVersions()`
- Renames the enum value `SighticAlignmentStatus.blink` to `SighticAlignmentStatus.eyesTooClosed`
- Changes API for supported devices from a factory function to a simple init
- Adds an option to allow the server to save the input data when calling `performInference()`