CBLCorePluginEntryPoint

Objective-C

@protocol CBLCorePluginEntryPoint <NSObject>

Swift

protocol PluginEntryPoint : NSObjectProtocol

This protocol defines the protocol expected by CascableCore when loading your plugin via the information found in the plugin’s Info.plist keys.

  • The identifier of the plugin.

    Declaration

    Objective-C

    @property (class, nonatomic, copy, readonly, nonnull) NSString *pluginIdentifier;

    Swift

    static var pluginIdentifier: String { get }
  • The camera family provider by the plugin.

    Declaration

    Objective-C

    @property (class, nonatomic, readonly) CBLCameraFamily providedCameraFamily;

    Swift

    static var providedCameraFamily: CameraFamily { get }
  • Called by CascableCore exactly once during your plugin’s lifecycle. Use the passed objects to register your plugin with CascableCore — if not done, your plugin will never be invoked.

    Registered objects will be strongly retained by CascableCore.

    Declaration

    Objective-C

    - (void)registerPlugin:
        (id<CBLCorePluginRegistration> _Nonnull)pluginRegistration;

    Swift

    func register(with pluginRegistration: PluginRegistration)

    Parameters

    pluginRegistration

    The interop object with which to register your plugin with CascableCore.