LensesComponent

interface LensesComponent : Closeable

Provides access to all available features of lenses. Normally, an instance of a component is acquired through com.snap.camerakit.Session which manages the lifecycle of the component.

Types

Audio

interface Audio

Provides control over the lenses audio.

Builder

interface Builder

Cache

interface Cache

Provides ability to interact with lenses content cache used by LensesComponent.

Carousel

interface Carousel

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

Hints

interface Hints

Provides ability to interact with lens hints feature which can be enabled with Configuration supplied to LensesComponent.Builder.configureHints method.

Lens

interface Lens

Defines the data model of a lens that is available to be used by LensesComponent exposed features.

LoadingOverlay

interface LoadingOverlay

Provides ability to interact with lens loading overlay feature which can be enabled with Configuration supplied to LensesComponent.Builder.configureLoadingOverlay method.

MediaPicker

interface MediaPicker

Provides ability to interact with lens media picker feature which can be enabled with Configuration supplied to LensesComponent.Builder.configureMediaPicker method.

Noop

object Noop : LensesComponent

Implementation of LensesComponent which does nothing.

Preferences

interface Preferences

Provides ability to interact with storage used by lenses to store user specific data such as game or on-boarding state, options etc.

Prefetcher

interface Prefetcher

Provides ability to prefetch content of lenses before they are applied using a Processor.

Processor

interface Processor : ImageProcessor, AudioProcessor, UserProcessor, LocationProcessor, SafeRenderAreaProcessor, MediaProcessor

Extension of ImageProcessor that allows to apply and remove lenses on top of the incoming image and audio input stream rendered to connected outputs.

RemoteApiService

interface RemoteApiService : Closeable

Provides ability to handle remote API requests that originate within lenses.

Repository

interface Repository

Provides ability to query lenses that are available to interact with by specific criteria.

Functions

abstract override fun close()

Closes all resources allocated for this LensesComponent.

Properties

audio

open val audio: LensesComponent.Audio

Provides control over the lenses audio.

carousel

open val carousel: LensesComponent.Carousel

Provides a Carousel of lenses available to interact with during this component lifecycle.

preferences

open val preferences: LensesComponent.Preferences

Provides a Preferences of lenses available to interact with during this component lifecycle.

prefetcher

open val prefetcher: LensesComponent.Prefetcher

Provides a Prefetcher of lenses available to interact with during this component lifecycle.

processor

open val processor: LensesComponent.Processor

Provides lenses specific Processor which allows to process image and audio input with applied lenses while rendering results to connected outputs.

repository

open val repository: LensesComponent.Repository

Provides a Repository of lenses available to interact with during this component lifecycle.

Inheritors

LensesComponent