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

Lens

interface Lens

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

Types

Link copied to clipboard
object Companion

Provides ability to attach utility functions to the Lens interface on implementation side.

Link copied to clipboard
enum Facing : Enum<LensesComponent.Lens.Facing>

Defines all possible facings (inversely relative to user) that a lens can be designed for.

Link copied to clipboard
interface LaunchData

Represents an additional data that is passed to a lens at its launch time.

Link copied to clipboard
sealed class Media

Represents all expected media resources that can be associated with a Lens.

Link copied to clipboard
sealed class Preview

Represents data that can be used to display lens preview to a user.

Properties

Link copied to clipboard
abstract val facingPreference: LensesComponent.Lens.Facing?

Specifies a Facing that this lens is designed for, null when no preference is expressed.

Link copied to clipboard
abstract val groupId: String

Non-empty identifier of a group this lens belongs to.

Link copied to clipboard
abstract val icons: Set<LensesComponent.Lens.Media.Image>

A set of icon image resources that represent this lens, empty when not available.

Link copied to clipboard
abstract val iconUri: String?

Icon resource URI that represents this lens, null when not available.

Link copied to clipboard
abstract val id: String

Non-empty identifier of a unique lens available to be applied through processor.

Link copied to clipboard
abstract val name: String?

Human readable name of this lens, null when not available.

Link copied to clipboard
abstract val preview: LensesComponent.Lens.Preview?

Preview that represents this lens, null when not available.

Link copied to clipboard
abstract val previews: Set<LensesComponent.Lens.Media>

A set of preview media resources that represent this lens, empty when not available.

Link copied to clipboard
abstract val snapcodes: Set<LensesComponent.Lens.Media>

A set of snapcodes that represent this lens, empty when not available.

Link copied to clipboard
abstract val vendorData: Map<String, String>

Vendor specific metadata associated with this lens, empty by default.