fix: Rename getFrameProcessorPlugin to initFrameProcessorPlugin (#2038)

* fix: Rename `getFrameProcessorPlugin` to `initFrameProcessorPlugin`

* fix: Make nullable, add comments

* Format

* Update FrameProcessorPlugin.java

* Update FrameProcessorPlugin.h

* fix: Fix dead links

* Call super constructor

* Update ExampleFrameProcessorPlugin.java

* fix: Init calls

package/ios/Frame Processor/FrameProcessorPlugin.h

@@ -11,22 +11,38 @@
 #import "Frame.h"
 #import <Foundation/Foundation.h>
 
-/// The base class for a Frame Processor Plugin which can be called synchronously from a JS Frame
-/// Processor.
-///
-/// Subclass this class in a Swift or Objective-C class and override the `callback:withArguments:`
-/// method, and implement your Frame Processing there.
-///
-/// Use `[FrameProcessorPluginRegistry addFrameProcessorPlugin:]` to register the Plugin to the
-/// VisionCamera Runtime.
+/**
+ * The base class of a native Frame Processor Plugin.
+ *
+ * Subclass this to create a custom Frame Processor Plugin, which can be called from a JS Frame Processor.
+ * Once subclassed, it needs to be registered in the VisionCamera Frame Processor runtime via
+ * the `VISION_EXPORT_FRAME_PROCESSOR` or `VISION_EXPORT_SWIFT_FRAME_PROCESSOR` macros.
+
+ * See: <a href="https://react-native-vision-camera.com/docs/guides/frame-processors-plugins-ios">Creating Frame Processor Plugins (iOS)</a>
+ * for more information
+ */
 @interface FrameProcessorPlugin : NSObject
 
-/// The initializer for a Frame Processor Plugin class that takes optional object that consists
-/// options passed from JS layer
+/**
+ * The initializer of this Frame Processor Plugin.
+ * This is called everytime this Frame Processor Plugin is loaded from the JS side (`initFrameProcessorPlugin(..)`).
+ * Optionally override this method to implement custom initialization logic.
+ * - Parameters:
+ *   - options: An options dictionary passed from the JS side, or `nil` if none.
+ */
 - (instancetype _Nonnull)initWithOptions:(NSDictionary* _Nullable)options;
 
-/// The actual callback when calling this plugin. Any Frame Processing should be handled there.
-/// Make sure your code is optimized, as this is a hot path.
+/**
+ * The actual Frame Processor Plugin's implementation that runs when `plugin.call(..)` is called in the JS Frame Processor.
+ * Implement your Frame Processing here, and keep in mind that this is a hot-path so optimize as good as possible.
+ * See: <a href="https://react-native-vision-camera.com/docs/guides/frame-processors-tips#fast-frame-processor-plugins">Performance Tips</a>
+ *
+ * - Parameters:
+ *   - frame: The Frame from the Camera. Don't do any ref-counting on this, as VisionCamera handles that.
+ * - Returns: You can return any primitive, map or array you want.
+ *            See the <a href="https://react-native-vision-camera.com/docs/guides/frame-processors-plugins-overview#types">Types</a>
+ *            table for a list of supported types.
+ */
 - (id _Nullable)callback:(Frame* _Nonnull)frame withArguments:(NSDictionary* _Nullable)arguments;
 
 @end

package/ios/Frame Processor/VisionCameraProxy.h

@@ -30,7 +30,7 @@ public:
 private:
   void setFrameProcessor(jsi::Runtime& runtime, int viewTag, const jsi::Object& frameProcessor);
   void removeFrameProcessor(jsi::Runtime& runtime, int viewTag);
-  jsi::Value getFrameProcessorPlugin(jsi::Runtime& runtime, std::string name, const jsi::Object& options);
+  jsi::Value initFrameProcessorPlugin(jsi::Runtime& runtime, std::string name, const jsi::Object& options);
 
 private:
   std::shared_ptr<RNWorklet::JsiWorkletContext> _workletContext;

package/ios/Frame Processor/VisionCameraProxy.mm

@@ -65,7 +65,7 @@ std::vector<jsi::PropNameID> VisionCameraProxy::getPropertyNames(jsi::Runtime& r
   std::vector<jsi::PropNameID> result;
   result.push_back(jsi::PropNameID::forUtf8(runtime, std::string("setFrameProcessor")));
   result.push_back(jsi::PropNameID::forUtf8(runtime, std::string("removeFrameProcessor")));
-  result.push_back(jsi::PropNameID::forUtf8(runtime, std::string("getFrameProcessorPlugin")));
+  result.push_back(jsi::PropNameID::forUtf8(runtime, std::string("initFrameProcessorPlugin")));
   return result;
 }
 
@@ -94,7 +94,7 @@ void VisionCameraProxy::removeFrameProcessor(jsi::Runtime& runtime, int viewTag)
   });
 }
 
-jsi::Value VisionCameraProxy::getFrameProcessorPlugin(jsi::Runtime& runtime, std::string name, const jsi::Object& options) {
+jsi::Value VisionCameraProxy::initFrameProcessorPlugin(jsi::Runtime& runtime, std::string name, const jsi::Object& options) {
   NSString* key = [NSString stringWithUTF8String:name.c_str()];
   NSDictionary* optionsObjc = JSINSObjectConversion::convertJSIObjectToNSDictionary(runtime, options, _callInvoker);
   FrameProcessorPlugin* plugin = [FrameProcessorPluginRegistry getPlugin:key withOptions:optionsObjc];
@@ -128,9 +128,9 @@ jsi::Value VisionCameraProxy::get(jsi::Runtime& runtime, const jsi::PropNameID&
           return jsi::Value::undefined();
         });
   }
-  if (name == "getFrameProcessorPlugin") {
+  if (name == "initFrameProcessorPlugin") {
     return jsi::Function::createFromHostFunction(
-        runtime, jsi::PropNameID::forUtf8(runtime, "getFrameProcessorPlugin"), 1,
+        runtime, jsi::PropNameID::forUtf8(runtime, "initFrameProcessorPlugin"), 1,
         [this](jsi::Runtime& runtime, const jsi::Value& thisValue, const jsi::Value* arguments, size_t count) -> jsi::Value {
           if (count < 1 || !arguments[0].isString()) {
             throw jsi::JSError(runtime, "First argument needs to be a string (pluginName)!");
@@ -138,7 +138,7 @@ jsi::Value VisionCameraProxy::get(jsi::Runtime& runtime, const jsi::PropNameID&
           auto pluginName = arguments[0].asString(runtime).utf8(runtime);
           auto options = count > 1 ? arguments[1].asObject(runtime) : jsi::Object(runtime);
 
-          return this->getFrameProcessorPlugin(runtime, pluginName, options);
+          return this->initFrameProcessorPlugin(runtime, pluginName, options);
         });
   }