CameraKit/com.snap.camerakit.lenses/LensesComponent/Carousel

Carousel

Provides ability to interact with lenses carousel feature which can be enabled with Configuration supplied to LensesComponent.Builder.configureCarousel method.

Inheritors

Noop

Types

Configuration

interface Configuration

Exposes configuration options available to lenses carousel feature.

Event

sealed class Event

All lenses carousel lifecycle events available to observe.

ItemOptions

interface ItemOptions

Represents options to customize lenses carousel item appearance.

LayoutPlacement

sealed class LayoutPlacement

Describes directional placement relative to the lens carousel.

Noop

object Noop : LensesComponent.Carousel

Side

enum Side : Enum<LensesComponent.Carousel.Side>

Describes position on the left or right to the center of lenses carousel.

View

interface View : Consumer<LensesComponent.Carousel.View.Model>

Defines a contract of a view that is called to show and hide lenses carousel.

Functions

activate

abstract fun activate(lens: LensesComponent.Lens? = null, callback: Consumer<Boolean> = Consumer {})

Attempts to activate lenses carousel with an optional Lens pre-selected. The operation is async with the result provided as success or failure flag to the callback.

deactivate

abstract fun deactivate(callback: Consumer<Boolean> = Consumer {})

Attempts to deactivate lenses carousel. The operation is async with the result provided as success or failure flag to the callback.

observe

@CheckResult

abstract fun observe(onEvent: Consumer<LensesComponent.Carousel.Event>): Closeable

Allows to observe lenses carousel lifecycle events defined in Event.