FIRVision


@interface FIRVision : NSObject

A Firebase service that supports vision APIs.

  • Gets an instance of Firebase Vision service for the default Firebase app. This method is thread safe. The default Firebase app instance must be configured before calling this method; otherwise raises FIRAppNotConfigured exception.

    Declaration

    Objective-C

    + (nonnull instancetype)vision;

    Return Value

    A Firebase Vision service instance, initialized with the default Firebase app.

  • Gets an instance of Firebase Vision service for the custom Firebase app. This method is thread safe.

    Declaration

    Objective-C

    + (nonnull instancetype)visionForApp:(nonnull FIRApp *)app;

    Parameters

    app

    The custom Firebase app used for initialization. Raises FIRAppInvalid exception if app is nil.

    Return Value

    A Firebase Vision service instance, initialized with the custom Firebase app.

  • Unavailable.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Gets a barcode detector with the given options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionBarcodeDetector *)barcodeDetectorWithOptions:
        (nonnull FIRVisionBarcodeDetectorOptions *)options;

    Parameters

    options

    Options containing barcode detector configuration.

    Return Value

    A barcode detector configured with the given options.

  • Gets a barcode detector with the default options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionBarcodeDetector *)barcodeDetector;

    Return Value

    A barcode detector configured with the default options.

  • Gets a face detector with the given options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionFaceDetector *)faceDetectorWithOptions:
        (nonnull FIRVisionFaceDetectorOptions *)options;

    Parameters

    options

    Options for configuring the face detector.

    Return Value

    A face detector configured with the given options.

  • Gets a face detector with the default options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionFaceDetector *)faceDetector;

    Return Value

    A face detector configured with the default options.

  • Gets a label detector with the given options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionLabelDetector *)labelDetectorWithOptions:
        (nonnull FIRVisionLabelDetectorOptions *)options;

    Parameters

    options

    Options for configuring the label detector.

    Return Value

    A label detector configured with the given options.

  • Gets a label detector with the default options. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionLabelDetector *)labelDetector;

    Return Value

    A label detector configured with the default options.

  • Gets a text detector. The returned detector is not thread safe.

    Declaration

    Objective-C

    - (nonnull FIRVisionTextDetector *)textDetector;

    Return Value

    A text detector.

  • Gets an instance of cloud landmark detector with the given options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudLandmarkDetector *)cloudLandmarkDetectorWithOptions:
        (nonnull FIRVisionCloudDetectorOptions *)options;

    Parameters

    options

    Options for configuring the cloud landmark detector.

    Return Value

    A cloud landmark detector configured with the given options.

  • Gets an instance of cloud landmark detector with default options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudLandmarkDetector *)cloudLandmarkDetector;

    Return Value

    A cloud landmark detector configured with default options.

  • Undocumented

    Declaration

    Objective-C

    - (FIRVisionCloudLabelDetector *)cloudLabelDetectorWithOptions:
        (FIRVisionCloudDetectorOptions *)options NS_SWIFT_NAME(cloudLabelDetector(options:));
  • Gets an instance of cloud label detector with default options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudLabelDetector *)cloudLabelDetector;

    Return Value

    A cloud label detector configured with default options.

  • Gets an instance of cloud text detector with the given options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudTextDetector *)cloudTextDetectorWithOptions:
        (nonnull FIRVisionCloudDetectorOptions *)options;

    Parameters

    options

    Options for configuring the cloud text detector.

    Return Value

    A cloud text detector configured with the given options.

  • Gets an instance of cloud text detector with default options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudTextDetector *)cloudTextDetector;

    Return Value

    A cloud text detector configured with default options.

  • Gets an instance of cloud document text detector with the given options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudDocumentTextDetector *)
    cloudDocumentTextDetectorWithOptions:
        (nonnull FIRVisionCloudDetectorOptions *)options;

    Parameters

    options

    Options for configuring the cloud text detector.

    Return Value

    A cloud document text detector configured with the given options.

  • Gets an instance of cloud document text detector with default options.

    Declaration

    Objective-C

    - (nonnull FIRVisionCloudDocumentTextDetector *)cloudDocumentTextDetector;

    Return Value

    A cloud document text detector configured with default options.