Configuration

interface Configuration

Exposes configuration options available to lenses carousel feature.

Functions

attachViewTo
Link copied to clipboard
abstract fun attachViewTo(layoutPlacement: LensesComponent.Carousel.LayoutPlacement, onViewStub: Consumer<ViewStub>)
Allows placing of views relative to the carousel based on a given LayoutPlacement.
configureEachItem
Link copied to clipboard
Allows to configure each lenses carousel item by receiving ItemOptions in the provided Consumer.
observeGroupIds
Link copied to clipboard
open fun observeGroupIds(vararg groupIds: String): <ERROR CLASS>

Properties

activateIdle
Link copied to clipboard
abstract var activateIdle: Boolean
By default, carousel reacts to interactions of processor and displays any applied lens as selected, while this option enables carousel to start in the idle state where no lens is yet applied and selected.
activateOnStart
Link copied to clipboard
abstract var activateOnStart: Boolean
By default, carousel reacts to interactions of processor and displays any applied lens as selected, while this option enables carousel to start in an activated state - idle or with a lens selected if disableIdle is true.
activateOnTap
Link copied to clipboard
abstract var activateOnTap: Boolean
Enables activation of lenses carousel by a tap gesture on the root view that the CameraKit views are inflated to.
closeButtonEnabled
Link copied to clipboard
abstract var closeButtonEnabled: Boolean
Sets whether the carousel close button should be visible and operational or completely disabled, invisible.
closeButtonMarginBottomDimenRes
Link copied to clipboard
abstract var closeButtonMarginBottomDimenRes: Int?
Sets the carousel close button bottom margin to the value of provided dimension resource.
deactivateOnClose
Link copied to clipboard
abstract var deactivateOnClose: Boolean
Enables deactivation of lenses carousel by clicking on close button when closeButtonEnabled is true.
disableIdle
Link copied to clipboard
abstract var disableIdle: Boolean
Disables presentation of the idle state - an empty item which can be selected to remove any previously applied lens.
enabled
Link copied to clipboard
abstract var enabled: Boolean
True if carousel feature should be enabled.
heightDimenRes
Link copied to clipboard
abstract var heightDimenRes: Int?
Sets the carousel height to the value of provided dimension resource.
marginBottomDimenRes
Link copied to clipboard
abstract var marginBottomDimenRes: Int?
Sets the carousel bottom margin to the value of provided dimension resource.
observedGroupIds
Link copied to clipboard
abstract var observedGroupIds: Set<String>
Uses the provided observedGroupIds to present lenses in carousel.
observedGroupIdsProvider
Link copied to clipboard
abstract var observedGroupIdsProvider: Callable<Set<String>>
Allows to asynchronously provide lens group IDs to present lenses in carousel.
paddingBottomDimenRes
Link copied to clipboard
abstract var paddingBottomDimenRes: Int?
Sets the carousel bottom padding to the value of provided dimension resource.
paddingTopDimenRes
Link copied to clipboard
abstract var paddingTopDimenRes: Int?
Sets the carousel top padding to the value of provided dimension resource.
view
Link copied to clipboard
abstract var view: LensesComponent.Carousel.View?
Custom implementation of Carousel.View to be used as a delegate to show and hide lenses carousel.