SCCameraKitLens

Objective-C

@protocol SCCameraKitLens <NSObject>

Swift

protocol Lens : NSObjectProtocol

Describes a lens object.

  • A unique identifier for the lens.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NS_SWIFT_NAME(id) NSString *identifier;

    Swift

    var id: String { get }

  • A unique identifier for the group that the lens belongs to

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NS_SWIFT_NAME(groupId) NSString *groupIdentifier;

    Swift

    var groupId: String { get }

  • The name for the lens

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *name;

    Swift

    var name: String? { get }

  • URL for icon image

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSURL *iconUrl;

    Swift

    var iconUrl: URL? { get }

  • Lens preview instance

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) id<SCCameraKitLensPreview> _Nonnull preview;

    Swift

    var preview: LensPreview { get }

  • Extra metadata provided from vendor

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSDictionary<NSString *, NSString *> *_Nonnull vendorData;

    Swift

    var vendorData: [String : String] { get }

  • Specifies which facing a lens is designed for.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCCameraKitLensFacingPreference facingPreference;

    Swift

    var facingPreference: LensFacingPreference { get }