All notable changes to the Camera Kit SDK will be documented in this file.
The format is based on Keep a Changelog, and the Camera Kit SDK adheres to Semantic Versioning.
- Lens Studio 5.4 support
- Support for Lens HTTP requests
- Lens Studio 5.3 support
- Updated basic sample application to apply single specified Lens
- Optimized Camera Kit Session initialization for better performance
- Launched a dedicated Android repository: https://github.com/Snapchat/camera-kit-android-sdk
- Lens Studio 5.2 support
- Lens Studio 5.1 support
- Lens Studio 5.0.19 support
- Lens Studio 5.0.17 support
- Lens Studio 5.0.14 support
- New
camerakit-sample-basicsample app demonstrates a simplistic way to integrate Camera Kit into your application.
- Lens Studio 5.0.10 support
- Added new
LensPushToDeviceService#initiatePairingandLensPushToDeviceService#unpairmethods to pair and unpair Push-to-Device without using default UI.
- Fix for incorrect processing size that sometimes resulted in pixelated image on some of the Android devices
- Fix an issue when
LensesComponent.Processor#clear()doesn't remove a lens while using custom UI. - Fix a crash when using Push-To-Device.
- Lens Studio 5.0.2 support
- Addressed behavior changes for apps targetting Android 14 or higher (behavior-changes-14).
- Lens elements that use overlay render target may be get incorrectly positioned when camera input does not match preview output aspect ratio
- Lens audio playback is not muted when app is paused
- HIGH_SAMPLING_RATE_SENSORS permission declaration is missing in the core SDK manifest
- Early display rotation notification causing incorrect input processing size calculation on Android 14
- Lens Studio 4.55 support
- Helper method to record
ImageProcessoroutput into a video file,connectOutput(file: File, width: Int, height: Int, captureAudio: Boolean), has been moved into a separate Maven artifact,com.snap.camerakit:support-media-recording. This artifact can now be excluded from an app's dependencies if the provided video recording functionality is not needed. Note that thecom.snap.camerakit:support-cameraxandcom.snap.camerakit:support-arcorenow depend on this new artifact transitively in order to implement thecom.snap.camerakit.support.camera.AllowsVideoCaptureinterface. - Helper method to create an instance of
Source<MediaProcessor>based onandroid.provider.MediaStore,mediaStoreSourceFor(context: Context, executorService: ExecutorService): Source<MediaProcessor>, has been moved into a separate Maven artifact,com.snap.camerakit:support-media-picker-source. This artifact can now be excluded from an app's dependencies if the provided media source functionality is not needed. Note that thecom.snap.camerakit:support-camera-layoutnow depends on this new artifact transitively in order to obtain media for media picker lenses. - Default lenses carousel UI has been removed from the core
com.snap.camerakit:camerakitartifact. Instead,com.snap.camerakit:support-lenses-carouselartifact should be added to app dependencies to use default lenses carousel UI. Note that thecom.snap.camerakit:support-camera-layoutnow depends on this artifact transitively in order to show lenses carousel UI. - Default media picker UI has been moved from the core
com.snap.camerakit:camerakitartifact, and moved into a separate Maven artifact,com.snap.camerakit:support-media-picker-ui. This new artifact should be added to app dependencies to use default media picker UI. Note that thecom.snap.camerakit:support-camera-layoutnow depends on this new artifact transitively in order to show media picker UI.
- Lens UI elements assinged to the overlay render target can get incorrectly positioned when device camera input frame does not match preview preview frame aspect ratio
- Lens Studio 4.53 support
- Fix a bug in the ARCore field of view, which was causing poor performance and incorrect object positioning for world tracking lenses
- Fix a bug when the first lens in the carousel has not been applied if
LensesComponent.Carousel.Configuration#disableIdleset totrue
- Lens Studio 4.49 support
- Add a Profiling Extension to monitor the Camera Kit performance. See Profiling.
- Add a new API to get lens snapcode image and deep link URIs, usage example:
session.lenses.repository.get(LensesComponent.Repository.QueryCriteria.Available("lens-group-id")) { result ->
result.whenHasFirst { lens ->
val snapcodePngUri = lens.snapcodes.find { it is LensesComponent.Lens.Media.Image.Png }?.uri
val snapcodeDeepLinkUri = lens.snapcodes.any { it is LensesComponent.Lens.Media.DeepLink }?.uri
}
}- Added
android.Manifest.permission.READ_MEDIA_VIDEOandandroid.Manifest.permission.READ_MEDIA_IMAGESpermissions for thecamerakit-sample-fullandcamerakit-sample-simpleapps. Those are the permissions required to access media files on devices when using the Media Picker lenses feature.
- Lens Studio 4.47 support
- Add a new API to get lens preview sequences -
LensesComponent.Lens.Media.Sequence, usage example:
session.lenses.repository.get(LensesComponent.Repository.QueryCriteria.Available("lens-group-id")) { result ->
result.whenHasFirst { lens ->
(lens.previews.find { preview ->
preview is LensesComponent.Lens.Media.Sequence.Webp
} as? LensesComponent.Lens.Media.Sequence.Webp)?.let { webpSequence ->
webpSequence.values.forEach { imageUri ->
// do something with each image
}
}
}
}- Prompt users to install a new ArCore version when available when using lenses that require it
- Deprecate application ID, remove its use across sample apps
- Add a debug dialog to swap API token for testing
- Lens Studio 4.46 support
- Fix a bug introduced in the
1.18.0version where lenses exported from the Lens Studio version4.31and prior can lead to a crash on Adreno GPU based devices
- Lens Studio 4.43 support
- Remove "Share with Snapchat" placeholder button
- Add examples on how to remove the control strip from the
CameraActivity
- Lens Studio 4.40 support
- Add a way to collect Camera Kit diagnostics information on-demand. This feature can be enabled when an issue in Camera Kit is encountered, please reach out to the Camera Kit support for further instructions.
- Fix a crash caused by
RejectedExecutionExceptionafterSessionis closed
- Lens Studio 4.36 support
- Add a new sample app that demonstrates a custom implementation of lenses carousel and camera preview layout
- Remove deprecated lens icon/preview accessors:
LensesComponent.Lens.iconUrireplaced byicons.find { it is LensesComponent.Lens.Media.Image.Png }?.uriLensesComponent.Lens.previewreplaced bypreviews.find { it is LensesComponent.Lens.Media.Image.Webp }?.uri
- Fix occasional camera preview freeze in
CameraXImageProcessorSourcewhen switching from an ARCore based camera preview source
- Fix an issue where touch gestures are not be processed by lenses if no
Viewis provided toLensesComponent.Builder#dispatchTouchEventsTo
- Lens Studio 4.34 support
- Custom Location AR (Beta feature) support
- Snap attribition support as per Design Guidelines
- Staging Watermark applies on staging builds of Camera Kit integrations
- Update CameraX dependencies to 1.1.0
- Update sample app project to the latest Gradle/AGP 7+ and Kotlin 1.6.21 versions
- Fix crash due to exceeded number of listeners registered via
TelephonyRegistryManager
- Fix an issue where touch gestures are not be processed by lenses if no
Viewis provided toLensesComponent.Builder#dispatchTouchEventsTo
- Lens Studio 4.31 support
- Add support for City-Scale AR Lenses (Beta)
- Add support for Push-to-Device (P2D) feature (Beta), which allows developers to send Lenses from Lens Studio to their Camera Kit application for testing. Note that on Android, P2D is only supported if your application uses the built-in lenses carousel.
- Expose new API to obtain WebP lens icon resources, switch the built-in lenses carousel to use it by default. Note that PNG lens icon resources are deprecated, to be removed in 1.19.0.
- Fix an issue causing ArCore camera freeze
- Fix crash when switching ArCore powered lenses
- This version has critical issues on Android. Use version 1.15.1 instead
- Lens Studio 4.25 support
- New method to apply a lens while resetting its state if the lens was applied already. Useful for cases where app resume from background or other screen should reset lens state matching Snapchat-like behavior. Usage example:
session.lenses.processor.apply(lens, reset = true)
- Improve ARCore performance
- Fix possible crash when internal remote service is not available
- Fix critical issues with lenses configuration introduced in 1.14.0
- This version has critical issues on Android. Use version 1.14.1 instead
- Lens Studio 4.22 support
- Add support for lenses with static assets
- New API to obtain the current version of the Camera Kit SDK
- New API to support lenses which use the remote service feature
- New tone-mapping and portrait camera adjustments
- Add support for ring flash mode for front-facing camera flash
- Add missing permission HIGH_SAMPLING_RATE_SENSORS for host-apk dynamic sample
- Fix processed bitmap rotation when no lens is applied
- Starting with this release, an API token must be provided as part of the Camera Kit configuration, failure to do so will result in a runtime exception. See Android and iOS documentation for examples on how to obtain and provide an API token.
- The legal agreement prompt has been updated to use a more user friendly text copy. Updating to this release will result in users needing to accept the updated prompt which includes a new link to the Camera Kit's "learn more" page.
- Lens Studio 4.19 support
- Add dynamic feature loading (DFM) reference sample app
- New
ImageProcessor.Input.Option.Cropwhich allows to specify the crop region that should be applied to each frame before processing CameraXImageProcessorSource#startPreviewtakes aspect ratio and crop option parameters- Further binary size reduction of about 500KB
- Missing
android.permission.ACCESS_COARSE_LOCATIONpermission added to thecamerakit-support-gms-locationartifact to support apps targeting Android API 31 - Image capture of certain lenses results in an unexpected alpha channel
- Race condition of incorrectly evicting currently applied lens content from cache while prefetching other lenses
- Lenses using the new Text to Speech feature throw a runtime exception on Android and simply do nothing on iOS. This is expected as the feature is currently unavailable in Camera Kit.
- Fix bug where landmarkers would not work properly
- Add support for text input in lenses
- Lens Studio 4.16 support
- Use consistent directory names for files related to Camera Kit
- Certain emulator images fail to render lenses
- Expose new API to switch camera facing based on lens facing preference
- Remove R8 specific consumer rules to support legacy Proguard builds
- Fix race conditions during face detection in the default Media Picker
- Don't start LegalPromptActivity if the legal prompt is already accepted
- Remote service calls fail after
Sessionis used for more than 60 seconds
- Lens Studio 4.13 support
- Persist custom lens groups in sample app
- Fix sharing captured media in sample app for some Android OS versions
- Eliminate native libraries binary size regression
- Extension fail to register when Kotlin reflect library is included
- Remove unused code which gets flagged as zip path traversal vulnerability
- Expose a method to observe LegalProcessor results
- Flash functionality in
CameraLayoutandCameraXImageProcessorSource
- Missing localized strings
- Lenses using ML features crash when app targets Android 12 (API level 31)
- Crop ARCore video to screen size by default
- Add audio recording permission check for Custom Video Sample app
- Rendering performance improvement
- Add thread monitoring and safety to video sample
- Legal agreement prompt pop-up dialog support
- Rotation detection for continuous focus
- Tap-To-Focus support
- Support API token based authorization
- Lenses audio mute/unmute support
- Add sample app for custom implementation of audio and video recording
- Extension API mismatch
- Kotlin Intrinsics leak into the public Plugin API
- CameraLayout treats optional permissions as required
- Lens Studio 4.7 support
- Fix an issue introduced in 1.7.1 that downgraded SDK performance
- Fix touch re-dispatch when lenses carousel de-activated
- Fix multiple startPreview leading to a crash in CameraX
- CameraActivity for simple use cases
- CameraLayout support view for simplified integration
- Lenses Carousel reference UI
- Gallery media source support for the MediaProcessor
- Enable/disable SnapButtonView based on lens download status
- Added SRE metrics
- Landmarkers localisation issues
- Face tracking issues introduced in 1.6.15
- LensStudio 4.5 support
- Stability issues
- Lenses Carousel does not appear on some devices
- Avoid reading cache size config on the Main thread
- Lens processing failure after image/video capture
- SurfaceTexture based Output Surface leak
- Too broad Proguard rule for GMS FaceDetector
- Fix Surface not released if Output connection is cancelled
- Lens localized hint strings are cached incorrectly
- Incorrect lens download status
- Carousel accessibility improvements
- Add support for client defined safe render area
- Add Media Picker support for sample app
- Switch to ARCore for surface tracking in the sample app
- SnapButtonView responds to volume up events to start capture
- Dialog to update lens group IDs in the sample app
- SnapButtonView re-dispatch touch events to lenses carousel
- Landmarker lenses support
- Negotiate MediaCodec supported resolution when video recording
- Expose outputRotationDegrees parameter for photo processing
- Better accessibility support
- Lens Single Tap should work without touch blocking
- OpenGL memory leak after Session is closed
- Expose lens loading overlay configuration
- Fix carousel actions being ignored after re-activation
- Add ability to clear ImageProcessor.Output on disconnect
- Dynamic Plugin class loading is not reliable
- Dynamic Plugin class loading is not reliable
- Missing lenses carousel center icon
- Better portrait orientation support
- Use externally published Plugin interface for dynamic loading
- Customize lenses carousel with custom item positions
- Expose API to disable default camera preview rendering
- Expose lens preview model
- Use exposed lenses carousel API to implement lens button
- Improve dynamic loading sample plugin example
- Camera zoom support example
- Missing lens placeholder icon
- Better portrait orientation support
- Missing lenses carousel center icon
- Crash when user app targets API level 30 on Android Q (11) devices
- Crash after required permissions accepted
- Added Configuration for Processor to support different input frame rotation behaviors
- Customize lenses carousel with custom item positions and activation flow
- Expose lens preview model
- Improve dynamic loading sample plugin example
- Expose API to disable default camera preview rendering
- Dynamic feature-as-a-plugin example
- Missing lenses carousel center icon
- Better portrait orientation support
- Customize lenses carousel with custom item positions
- Expose API to disable default camera preview rendering
- Expose lens preview model
- Use exposed lenses carousel API to implement lens button
- Improve dynamic loading sample plugin example
- Camera zoom support example
- Missing lenses carousel center icon
- Customize lenses carousel with custom item positions and activation flow
- Crash when user app targets API level 30 on Android Q (11) devices
- Better portrait orientation support
- Crash after required permissions accepted
- Improve dynamic loading sample plugin example
- Expose API to disable default camera preview rendering
- Dynamic feature-as-a-plugin example
- Support photo API captured image processing
- Support dynamic feature loading
- Processed texture interpolation artifacts when resized
- OpenGL out of memory crash
- Lenses Processor apply callback not invoked
- Add instrumentation test helpers
- Invalidate metadata cache on cold-start when network is available
- Add ability to check if device is supported
- Reapply lens with launch data if available
- Add x86/x86_64 support
- Progress cycle repeat parameters for SnapButtonView
- Add support for dynamic lens launch data
- Add ability to provide ImageProcessor.Output rotation
- Add post capture preview screen
- Add support to provide user data
- Memory leaks caused by delayed operations
- Handle/abort connection to invalid output surface
- Offline lens repository support
- Add support for prefetching lenses content
- Add support for lens hints
- Expose Lens vendor data
- Remove 3rd-party R classes jars from the SDK binary
- Audio processing (analysis and effects) support
- Use lens lifecycle events to update camera UI
- Add support for internal cache configuration
- Integrate SnapButtonView for photo/video capture
- Allow simultaneous touch handling while recording
- Picture/video sharing does not work on Android 10
- Notify lenses list change once network is available
- Shutdown Camera Kit when app ID is unauthorized
- Restart lens tracking on single tap gesture
- Audio playback continues when app is in background
- Add missing application ID
- Add version information to the side menu of sample app
- Save applied lens ID and camera facing in instance state
- Add camera flip button
- Open side drawer on lens button click
- Add next/previous lens buttons to the sample app
- Use Lens name in side bar listing