Google ML Kit Text Recognition

https://pub.dev/documentation/google_mlkit_text_recognition/latest
Admin
A Flutter plugin for Google's ML Kit Text Recognition API that enables OCR to recognize text in...
Tokens:11,388
Snippets:166
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create an instance of InputImage

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Declare a final InputImage variable. The actual initialization is described in the linked guide.

```dart
final InputImage inputImage;

```

--------------------------------

### RecognizedText.text

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/RecognizedText-class.html

Gets the full recognized text string.

```APIDOC
## text → String

### Description
String containing all the text identified in an image. The string is empty if no text was recognized.

### Returns
String - The recognized text.
```

--------------------------------

### RecognizedText.blocks

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/RecognizedText-class.html

Gets the list of text blocks present in the image.

```APIDOC
## blocks → List<TextBlock>

### Description
All the blocks of text present in image.

### Returns
List<TextBlock> - The list of text blocks.
```

--------------------------------

### Process image and access recognized text

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Process the input image to get RecognizedText. Iterate over blocks, lines, and elements to access text, bounding boxes, corner points, and recognized languages.

```dart
final RecognizedText recognizedText = await textRecognizer.processImage(inputImage);

String text = recognizedText.text;
for (TextBlock block in recognizedText.blocks) {
  final Rect rect = block.boundingBox;
  final List<Point<int>> cornerPoints = block.cornerPoints;
  final String text = block.text;
  final List<String> languages = block.recognizedLanguages;

  for (TextLine line in block.lines) {
    // Same getters as TextBlock
    for (TextElement element in line.elements) {
      // Same getters as TextBlock
    }
  }
}

```

--------------------------------

### rawValue

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageRotationValue.html

Gets the raw integer value of the InputImageRotation enum value.

```APIDOC
## rawValue

### Description
Gets the raw integer value of the InputImageRotation enum value.

### Property
- **rawValue** (int) - The raw integer value of the rotation.

### Availability
Available on InputImageRotation, provided by the InputImageRotationValue extension.

### Example
```dart
InputImageRotation rotation = InputImageRotation.rotation0;
int value = rotation.rawValue;
```
```

--------------------------------

### Configure Podfile for iOS 15.5 and exclude armv7

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Use this Podfile configuration to set the iOS deployment target to 15.5 or newer and exclude the armv7 architecture, which is required because ML Kit does not support 32-bit architectures. The post_install hook sets the deployment target for all pods and ensures it is not lower than the specified version.

```ruby
content_copyplatform :ios, '15.5'  # or newer version

...

# add this line:
$iOSVersion = '15.5'  # or newer version

post_install do |installer|
  # add these lines:
  installer.pods_project.build_configurations.each do |config|
    config.build_settings["EXCLUDED_ARCHS[sdk=*]"] = "armv7"
    config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = $iOSVersion
  end

  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)

    # add these lines:
    target.build_configurations.each do |config|
      if Gem::Version.new($iOSVersion) > Gem::Version.new(config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'])
        config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = $iOSVersion
      end
    end

  end
end

```

--------------------------------

### TextBlock constructor

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextBlock-class.html

Creates an instance of TextBlock with the given text, lines, bounding box, recognized languages, and corner points.

```APIDOC
## TextBlock({required String text, required List<TextLine> lines, required Rect boundingBox, required List<String> recognizedLanguages, required List<Point<int>> cornerPoints})

### Description
Constructor to create an instance of TextBlock.

### Parameters
- **text** (String) - Required - The recognized text of the block.
- **lines** (List<TextLine>) - Required - List of text lines that make up the block.
- **boundingBox** (Rect) - Required - Rect that contains the text block.
- **recognizedLanguages** (List<String>) - Required - List of recognized languages in the text block.
- **cornerPoints** (List<Point<int>>) - Required - List of corner points of the text block in clockwise order starting with the top left point.

### Example
```dart
TextBlock(
  text: 'Hello',
  lines: [...],
  boundingBox: Rect.fromLTWH(0, 0, 100, 50),
  recognizedLanguages: ['en'],
  cornerPoints: [Point(0,0), Point(100,0), Point(100,50), Point(0,50)],
)
```
```

--------------------------------

### downloadModel(String model, {bool isWifiRequired = true}) → Future<bool>

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/ModelManager-class.html

Downloads a model. Returns true if model downloads successfully or model is already downloaded. On failing to download it throws an error.

```APIDOC
## downloadModel(String model, {bool isWifiRequired = true}) → Future<bool>

### Description
Downloads a model. Returns true if model downloads successfully or model is already downloaded. On failing to download it throws an error.

### Parameters
- **model** (String) - Required - The model to download.
- **isWifiRequired** (bool) - Optional - Whether Wi-Fi is required for the download. Defaults to true.

### Returns
Future<bool> - True if model downloads successfully or model is already downloaded.

### Errors
Throws an error if the download fails.

```

--------------------------------

### InputImageMetadata constructor

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageMetadata-class.html

Constructor to create an instance of InputImageMetadata with required parameters: size, rotation, format, and bytesPerRow.

```APIDOC
## InputImageMetadata({required Size size, required InputImageRotation rotation, required InputImageFormat format, required int bytesPerRow})

### Description
Constructor to create an instance of InputImageMetadata.

### Parameters
- **size** (Size) - Required - Size of image.
- **rotation** (InputImageRotation) - Required - Image rotation degree.
- **format** (InputImageFormat) - Required - Format of the input image.
- **bytesPerRow** (int) - Required - The row stride for color plane, in bytes.

```

--------------------------------

### TextLine constructor

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextLine-class.html

Creates an instance of TextLine with the given text, elements, bounding box, recognized languages, corner points, confidence, and angle.

```APIDOC
## TextLine({required String text, required List<TextElement> elements, required Rect boundingBox, required List<String> recognizedLanguages, required List<Point<int>> cornerPoints, required double? confidence, required double? angle})

### Description
Constructor to create an instance of TextLine.

### Parameters
- **text** (String) - Required - String representation of the text line that was recognized.
- **elements** (List<TextElement>) - Required - List of text elements that make up the line.
- **boundingBox** (Rect) - Required - Rect that contains the text line.
- **recognizedLanguages** (List<String>) - Required - List of recognized languages in the text line. If no languages were recognized, the list is empty.
- **cornerPoints** (List<Point<int>>) - Required - The corner points of the text line in clockwise order starting with the top left point relative to the image in the default coordinate space.
- **confidence** (double?) - Required - Confidence of the recognition result.
- **angle** (double?) - Required - Angle of the text line.
```

--------------------------------

### InputImage.fromFile

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImage-class.html

Creates an instance of InputImage by passing a file. This factory constructor takes a File object.

```APIDOC
## InputImage.fromFile

### Description
Creates an instance of InputImage by passing a file.

### Constructor
`InputImage.fromFile(File file)`

### Parameters
- **file** (File) - Required - The file containing the image.

### Returns
An instance of InputImage.
```

--------------------------------

### TextSymbol({required String text, required Rect boundingBox, required List<String> recognizedLanguages, required List<Point<int>> cornerPoints, required double? confidence, required double? angle})

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextSymbol-class.html

Constructor to create an instance of TextSymbol with the given properties.

```APIDOC
## TextSymbol Constructor

### Description
Creates a TextSymbol instance with the specified text, bounding box, recognized languages, corner points, confidence, and angle.

### Parameters
- **text** (String) - Required - The recognized text of the symbol.
- **boundingBox** (Rect) - Required - The rectangle that contains the text symbol.
- **recognizedLanguages** (List<String>) - Required - List of recognized languages in the text symbol.
- **cornerPoints** (List<Point<int>>) - Required - List of corner points in clockwise order starting with the top left.
- **confidence** (double?) - Required - Confidence score of the recognition.
- **angle** (double?) - Required - Angle of the text symbol.

### Example
```dart
TextSymbol(
  text: 'A',
  boundingBox: Rect.fromLTWH(0, 0, 10, 10),
  recognizedLanguages: ['en'],
  cornerPoints: [Point(0,0), Point(10,0), Point(10,10), Point(0,10)],
  confidence: 0.9,
  angle: 0.0,
);
```
```

--------------------------------

### InputImage.fromBytes

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImage-class.html

Creates an instance of InputImage using bytes. This factory constructor takes the image bytes and associated metadata.

```APIDOC
## InputImage.fromBytes

### Description
Creates an instance of InputImage using bytes.

### Constructor
`InputImage.fromBytes({required Uint8List bytes, required InputImageMetadata metadata})`

### Parameters
- **bytes** (Uint8List) - Required - The bytes of the image.
- **metadata** (InputImageMetadata) - Required - The image metadata when creating an image of type = InputImageType.bytes.

### Returns
An instance of InputImage.
```

--------------------------------

### InputImage.fromBitmap

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImage-class.html

Creates an instance of InputImage from bitmap data. This factory constructor takes raw bitmap pixel data along with width, height, and an optional rotation.

```APIDOC
## InputImage.fromBitmap

### Description
Creates an instance of InputImage from bitmap data.

### Constructor
`InputImage.fromBitmap({required Uint8List bitmap, required int width, required int height, int rotation = 0})`

### Parameters
- **bitmap** (Uint8List) - Required - Raw bitmap pixel data.
- **width** (int) - Required - Width of the bitmap image.
- **height** (int) - Required - Height of the bitmap image.
- **rotation** (int) - Optional - Rotation degrees for the bitmap image. Defaults to 0.

### Returns
An instance of InputImage.
```

--------------------------------

### Create an instance of TextRecognizer

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Create a TextRecognizer with the Latin script. Other scripts require adding the corresponding language package dependencies.

```dart
final textRecognizer = TextRecognizer(script: TextRecognitionScript.latin);

```

--------------------------------

### InputImage.fromFilePath

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImage-class.html

Creates an instance of InputImage from the path of an image stored in the device. This factory constructor takes a file path string.

```APIDOC
## InputImage.fromFilePath

### Description
Creates an instance of InputImage from path of image stored in device.

### Constructor
`InputImage.fromFilePath(String path)`

### Parameters
- **path** (String) - Required - The file path to the image.

### Returns
An instance of InputImage.
```

--------------------------------

### TextRecognizer({TextRecognitionScript script = TextRecognitionScript.latin})

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextRecognizer-class.html

Constructor to create an instance of TextRecognizer.

```APIDOC
## TextRecognizer({TextRecognitionScript script = TextRecognitionScript.latin})

### Description
Constructor to create an instance of TextRecognizer.

### Parameters
- **script** (TextRecognitionScript) - Optional - Configurations for the language to be detected. Defaults to TextRecognitionScript.latin.

```

--------------------------------

### TextElement constructor

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextElement-class.html

Creates an instance of TextElement with the given text, symbols, bounding box, recognized languages, corner points, confidence, and angle.

```APIDOC
## TextElement({required String text, required List<TextSymbol> symbols, required Rect boundingBox, required List<String> recognizedLanguages, required List<Point<int>> cornerPoints, required double? confidence, required double? angle})

### Description
Creates an instance of TextElement with the specified properties.

### Parameters
- **text** (String) - Required - The recognized text string.
- **symbols** (List<TextSymbol>) - Required - List of text symbols that make up the element.
- **boundingBox** (Rect) - Required - Rect that contains the text element.
- **recognizedLanguages** (List<String>) - Required - List of recognized languages in the text element.
- **cornerPoints** (List<Point<int>>) - Required - List of corner points in clockwise order starting with the top left point.
- **confidence** (double?) - Required - Confidence score of the recognition.
- **angle** (double?) - Required - Angle of the text element.

### Returns
A new TextElement instance.
```

--------------------------------

### Enums

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

Enums for configuring text recognition and input image properties.

```APIDOC
## Enums

### InputImageFormat
- **nv21** - NV21 format.
- **yuv420** - YUV420 format.
- **rgba8888** - RGBA8888 format.

### InputImageRotation
- **rotation0deg** - 0 degrees.
- **rotation90deg** - 90 degrees.
- **rotation180deg** - 180 degrees.
- **rotation270deg** - 270 degrees.

### InputImageType
- **bytes** - Image from bytes.
- **file** - Image from file.
- **camera** - Image from camera.

### TextRecognitionScript
- **latin** - Latin script.
- **chinese** - Chinese script.
- **devanagari** - Devanagari script.
- **japanese** - Japanese script.
- **korean** - Korean script.

```

--------------------------------

### ModelManager({required MethodChannel channel, required String method})

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/ModelManager-class.html

Constructor to create an instance of ModelManager.

```APIDOC
## ModelManager({required MethodChannel channel, required String method})

### Description
Constructor to create an instance of ModelManager.

### Parameters
- **channel** (MethodChannel) - Required - The channel used to manage the remote model.
- **method** (String) - Required - The method name to be called.

```

--------------------------------

### isModelDownloaded(String model) → Future<bool>

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/ModelManager-class.html

Checks whether a model is downloaded or not.

```APIDOC
## isModelDownloaded(String model) → Future<bool>

### Description
Checks whether a model is downloaded or not.

### Parameters
- **model** (String) - Required - The model to check.

### Returns
Future<bool> - True if the model is downloaded, false otherwise.

```

--------------------------------

### Add iOS language package dependencies to Podfile

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Add these pods to the ios/Podfile to support Chinese, Devanagari, Japanese, and Korean text recognition. The default package only supports Latin characters.

```ruby
# Add language package you need to use
pod 'GoogleMLKit/TextRecognitionChinese', '~> 9.0.0'
pod 'GoogleMLKit/TextRecognitionDevanagari', '~> 9.0.0'
pod 'GoogleMLKit/TextRecognitionJapanese', '~> 9.0.0'
pod 'GoogleMLKit/TextRecognitionKorean', '~> 9.0.0'

```

--------------------------------

### RecognizedText constructor

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/RecognizedText-class.html

Creates an instance of RecognizedText with the given text and blocks.

```APIDOC
## RecognizedText({required String text, required List<TextBlock> blocks})

### Description
Constructor to create an instance of RecognizedText.

### Parameters
- **text** (String) - Required - The full text recognized in the image.
- **blocks** (List<TextBlock>) - Required - The list of text blocks present in the image.

### Returns
A new instance of RecognizedText.
```

--------------------------------

### TextLine.fromJson

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextLine-class.html

Factory constructor that returns an instance of TextLine from a given JSON map.

```APIDOC
## TextLine.fromJson(Map json)

### Description
Returns an instance of TextLine from a given `json`.

### Parameters
- **json** (Map) - Required - The JSON map containing the data for the TextLine.

### Returns
- **TextLine** - A new TextLine instance.
```

--------------------------------

### TextSymbol.fromJson(Map json)

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextSymbol-class.html

Factory constructor that returns a TextSymbol instance from a JSON map.

```APIDOC
## TextSymbol.fromJson

### Description
Creates a TextSymbol instance from a JSON map.

### Parameters
- **json** (Map) - Required - The JSON map containing the symbol data.

### Returns
- **TextSymbol** - A new TextSymbol instance.

### Example
```dart
final symbol = TextSymbol.fromJson(jsonMap);
```
```

--------------------------------

### InputImage

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

Image format that ML Kit takes to process the image. This class represents an input image for text recognition.

```APIDOC
## InputImage

### Description
Image format that ML Kit takes to process the image.

### Constructors
- **InputImage.fromBytes(Uint8List bytes, InputImageMetadata metadata)** - Creates an InputImage from bytes with metadata.
- **InputImage.fromFilePath(String path)** - Creates an InputImage from a file path.
- **InputImage.fromFile(File file)** - Creates an InputImage from a File object.
- **InputImage.fromCamera(...)** - Creates an InputImage from camera data.

### Parameters
- **bytes** (Uint8List) - Required - The image bytes.
- **metadata** (InputImageMetadata) - Required - The metadata of the image.
- **path** (String) - Required - The file path.
- **file** (File) - Required - The file object.

### Returns
- **InputImage** - An instance of InputImage.

```

--------------------------------

### TextBlock.fromJson

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextBlock-class.html

Returns an instance of TextBlock from a given JSON map.

```APIDOC
## TextBlock.fromJson(Map json)

### Description
Returns an instance of TextBlock from a given `json`.

### Parameters
- **json** (Map) - Required - The JSON map containing the text block data.

### Returns
- **TextBlock** - A new TextBlock instance.

### Example
```dart
final block = TextBlock.fromJson(jsonMap);
```
```

--------------------------------

### close() → Future<void>

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextRecognizer-class.html

Closes the recognizer and releases its resources.

```APIDOC
## close() → Future<void>

### Description
Closes the recognizer and releases its resources.

### Returns
Future<void> - A future that completes when the recognizer is closed.

```

--------------------------------

### InputImage.toJson

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImage-class.html

Returns a JSON representation of an instance of InputImage.

```APIDOC
## InputImage.toJson

### Description
Returns a json representation of an instance of InputImage.

### Method
`Map<String, dynamic> toJson()`

### Returns
A map representing the JSON serialization of the InputImage instance.
```

--------------------------------

### processImage(InputImage inputImage) → Future<RecognizedText>

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextRecognizer-class.html

Processes the given InputImage for text recognition and returns a RecognizedText object.

```APIDOC
## processImage(InputImage inputImage) → Future<RecognizedText>

### Description
Processes the given InputImage for text recognition and returns a RecognizedText object.

### Parameters
- **inputImage** (InputImage) - Required - The image to process for text recognition.

### Returns
Future<RecognizedText> - A future that resolves to the recognized text.

```

--------------------------------

### Add Android language package dependencies to build.gradle

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Add these dependencies to the android/app/build.gradle file to support Chinese, Devanagari, Japanese, and Korean text recognition. The default package only supports Latin characters.

```groovy
dependencies {
    // Add language package you need to use
    implementation 'com.google.mlkit:text-recognition-chinese:16.0.1'
    implementation 'com.google.mlkit:text-recognition-devanagari:16.0.1'
    implementation 'com.google.mlkit:text-recognition-japanese:16.0.1'
    implementation 'com.google.mlkit:text-recognition-korean:16.0.1'
}

```

--------------------------------

### toJson() method

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageMetadata-class.html

Returns a json representation of an instance of InputImageMetadata.

```APIDOC
## toJson() → Map<String, dynamic>

### Description
Returns a json representation of an instance of InputImageMetadata.

### Return Value
- **Map<String, dynamic>** - JSON representation of the metadata.

```

--------------------------------

### RecognizedText.fromJson

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/RecognizedText-class.html

Creates an instance of RecognizedText from a JSON map.

```APIDOC
## RecognizedText.fromJson(Map json)

### Description
Returns an instance of RecognizedText from a given `json`.

### Parameters
- **json** (Map) - Required - The JSON map containing the data.

### Returns
A new instance of RecognizedText.
```

--------------------------------

### fromJson(Map json) → Rect

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/RectJson.html

Returns an instance of Rect from a given `json` map. This static method is available on Rect via the RectJson extension.

```APIDOC
## fromJson(Map json) → Rect

### Description
Returns an instance of Rect from a given `json` map.

### Method
fromJson

### Signature
`static Rect fromJson(Map json)`

### Parameters
- **json** (Map) - Required - The JSON map containing the rectangle data.

### Returns
- **Rect** - A Rect instance constructed from the provided JSON.

### Example
```dart
final rect = RectJson.fromJson({'left': 10, 'top': 20, 'right': 100, 'bottom': 200});
```
```

--------------------------------

### TextElement.fromJson

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextElement-class.html

Creates a TextElement instance from a JSON map.

```APIDOC
## TextElement.fromJson(Map json)

### Description
Returns an instance of TextElement from a given `json` map.

### Parameters
- **json** (Map) - Required - The JSON map containing the text element data.

### Returns
A TextElement instance.
```

--------------------------------

### InputImageMetadata

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

Data of image required when creating image from bytes.

```APIDOC
## InputImageMetadata

### Description
Data of image required when creating image from bytes.

### Properties
- **size** (Size) - The size of the image.
- **rotation** (InputImageRotation) - The rotation of the image.
- **format** (InputImageFormat) - The format of the image.
- **planeData** (List<PlaneData>) - The plane data of the image.

```

--------------------------------

### TextBlock

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A text block recognized in an image that consists of a list of text lines.

```APIDOC
## TextBlock

### Description
A text block recognized in an image that consists of a list of text lines.

### Properties
- **text** (String) - The text of the block.
- **lines** (List<TextLine>) - The list of text lines.
- **boundingBox** (Rect) - The bounding box of the block.
- **recognizedLanguages** (List<String>) - The recognized languages.
- **confidence** (double?) - The confidence score.
- **angle** (double?) - The angle of the block.

```

--------------------------------

### InputImageFormat enum values

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageFormat.html

Lists the enum values for InputImageFormat, each indicating a specific image format supported on Android or iOS.

```APIDOC
## InputImageFormat enum

### Description
To indicate the format of image while creating input image from bytes.

### Values

- **nv21** (const InputImageFormat) - Android only: https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage#IMAGE_FORMAT_NV21
- **yv12** (const InputImageFormat) - Android only: https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage#public-static-final-int-image_format_yv12
- **yuv_420_888** (const InputImageFormat) - Android only: https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage#public-static-final-int-image_format_yuv_420_888
- **yuv420** (const InputImageFormat) - iOS only: https://developer.apple.com/documentation/corevideo/kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
- **bgra8888** (const InputImageFormat) - iOS only: https://developer.apple.com/documentation/corevideo/kcvpixelformattype_32bgra

### Properties

- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by EnumName extension)
- **rawValue** (int) - (provided by InputImageFormatValue extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods

- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** → String - A string representation of this object. (inherited)

### Operators

- **operator ==(Object other)** → bool - The equality operator. (inherited)

### Constants

- **values** → const List<InputImageFormat> - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### TextLine

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A text line recognized in an image that consists of a list of elements.

```APIDOC
## TextLine

### Description
A text line recognized in an image that consists of a list of elements.

### Properties
- **text** (String) - The text of the line.
- **elements** (List<TextElement>) - The list of text elements.
- **boundingBox** (Rect) - The bounding box of the line.
- **recognizedLanguages** (List<String>) - The recognized languages.
- **confidence** (double?) - The confidence score.
- **angle** (double?) - The angle of the line.

```

--------------------------------

### ModelManager

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A class to manage remote models. This class provides methods to manage remote models used by the text recognizer.

```APIDOC
## ModelManager

### Description
A class to manage remote models.

### Methods
- **downloadModel(TextRecognitionScript script)** - Downloads the remote model for the specified script.
- **deleteModel(TextRecognitionScript script)** - Deletes the downloaded model for the specified script.
- **isModelDownloaded(TextRecognitionScript script)** - Checks if the model for the specified script is downloaded.

### Parameters
- **script** (TextRecognitionScript) - Required - The script for which the model is managed.

### Returns
- **bool** - For isModelDownloaded, returns true if the model is downloaded.

```

--------------------------------

### InputImageFormatValue extension

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageFormatValue.html

The InputImageFormatValue extension provides a rawValue property and a fromRawValue static method for the InputImageFormat enum.

```APIDOC
## InputImageFormatValue extension

### Description
The InputImageFormatValue extension adds a rawValue property and a fromRawValue static method to the InputImageFormat enum.

### Properties

#### rawValue → int
- Available on InputImageFormat, provided by the InputImageFormatValue extension.
- No setter.
- Returns the integer raw value of the enum.

### Static Methods

#### fromRawValue(int rawValue) → InputImageFormat?
- Available on InputImageFormat, provided by the InputImageFormatValue extension.
- Converts an integer raw value to an InputImageFormat instance.
- Returns null if no matching enum value exists.

```

--------------------------------

### Release resources with close()

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/index.html

Call close() on the TextRecognizer to release resources when done.

```dart
textRecognizer.close();

```

--------------------------------

### Properties

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextSymbol-class.html

Properties of the TextSymbol class that provide access to the symbol's data.

```APIDOC
## Properties

### angle
- **Type**: double?
- **Description**: The angle of the text symbol.

### boundingBox
- **Type**: Rect
- **Description**: Rect that contains the text symbol.

### confidence
- **Type**: double?
- **Description**: Confidence score of the recognition.

### cornerPoints
- **Type**: List<Point<int>>
- **Description**: List of corner points of the text symbol in clockwise order starting with the top left point relative to the image in the default coordinate space.

### recognizedLanguages
- **Type**: List<String>
- **Description**: List of recognized languages in the text symbol. If no languages were recognized, the list is empty.

### text
- **Type**: String
- **Description**: String representation of the text symbol that was recognized.
```

--------------------------------

### deleteModel(String model) → Future<bool>

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/ModelManager-class.html

Deletes a model. Returns true if model is deleted successfully or model is not present.

```APIDOC
## deleteModel(String model) → Future<bool>

### Description
Deletes a model. Returns true if model is deleted successfully or model is not present.

### Parameters
- **model** (String) - Required - The model to delete.

### Returns
Future<bool> - True if model is deleted successfully or model is not present.

```

--------------------------------

### TextRecognitionScript enum

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/TextRecognitionScript.html

The TextRecognitionScript enum provides constants for supported language scripts. Use these values to configure a TextRecognizer for a specific script.

```APIDOC
## TextRecognitionScript enum

### Description
Configurations for TextRecognizer for different languages.

### Values
- **latin** (const TextRecognitionScript) - Latin script.
- **chinese** (const TextRecognitionScript) - Chinese script.
- **devanagiri** (const TextRecognitionScript) - Devanagiri script.
- **japanese** (const TextRecognitionScript) - Japanese script.
- **korean** (const TextRecognitionScript) - Korean script.

### Properties
- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by EnumName extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** (String) - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** (bool) - The equality operator. (inherited)

### Constants
- **values** (const List<TextRecognitionScript>) - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### TextRecognizer

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A text recognizer that recognizes text from a given InputImage. This is the main class for performing text recognition.

```APIDOC
## TextRecognizer

### Description
A text recognizer that recognizes text from a given InputImage.

### Methods
- **recognize(InputImage image)** - Recognizes text from the given input image.

### Parameters
- **image** (InputImage) - Required - The input image to process.

### Returns
- **RecognizedText** - The recognized text in the image.

```

--------------------------------

### fromRawValue

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageRotationValue.html

Converts a raw integer value to the corresponding InputImageRotation enum value, or returns null if no matching enum value exists.

```APIDOC
## fromRawValue

### Description
Converts a raw integer value to the corresponding InputImageRotation enum value, or returns null if no matching enum value exists.

### Method
`static InputImageRotation? fromRawValue(int rawValue)`

### Parameters
- **rawValue** (int) - The raw integer value to convert.

### Return Value
- **InputImageRotation?** - The corresponding InputImageRotation enum value, or null if no match.

### Availability
Available on InputImageRotation, provided by the InputImageRotationValue extension.

### Example
```dart
InputImageRotation? rotation = InputImageRotation.fromRawValue(0);
```
```

--------------------------------

### TextElement

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A text element recognized in an image. A text element is roughly equivalent to a space-separated word in most languages.

```APIDOC
## TextElement

### Description
A text element recognized in an image. A text element is roughly equivalent to a space-separated word in most languages.

### Properties
- **text** (String) - The text of the element.
- **symbols** (List<TextSymbol>) - The list of text symbols.
- **boundingBox** (Rect) - The bounding box of the element.
- **recognizedLanguages** (List<String>) - The recognized languages.
- **confidence** (double?) - The confidence score.
- **angle** (double?) - The angle of the element.

```

--------------------------------

### InputImageType enum

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageType.html

The InputImageType enum defines the type of an InputImage. It has three values: file, bytes, and bitmap.

```APIDOC
## InputImageType enum

### Description
The type of InputImage.

### Values
- **file** (const InputImageType) - Represents an input image from a file.
- **bytes** (const InputImageType) - Represents an input image from bytes.
- **bitmap** (const InputImageType) - Represents an input image from a bitmap.

### Properties
- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by EnumName extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** (String) - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** (bool) - The equality operator. (inherited)

### Constants
- **values** (const List<InputImageType>) - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### RecognizedText

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

Recognized text in an image. This class represents the result of text recognition.

```APIDOC
## RecognizedText

### Description
Recognized text in an image.

### Properties
- **text** (String) - The full recognized text.
- **blocks** (List<TextBlock>) - The list of text blocks.

```

--------------------------------

### InputImageRotation enum values

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition/InputImageRotation.html

The InputImageRotation enum provides four constant values representing rotation angles: rotation0deg, rotation90deg, rotation180deg, and rotation270deg.

```APIDOC
## InputImageRotation enum

### Description
The camera rotation angle to be specified.

### Values
- **rotation0deg** (InputImageRotation) - Rotation of 0 degrees.
- **rotation90deg** (InputImageRotation) - Rotation of 90 degrees.
- **rotation180deg** (InputImageRotation) - Rotation of 180 degrees.
- **rotation270deg** (InputImageRotation) - Rotation of 270 degrees.

### Properties
- **name** (String) - The name of the enum value. Provided by the EnumName extension.
- **rawValue** (int) - The raw integer value of the enum. Provided by the InputImageRotationValue extension.

### Constants
- **values** (List<InputImageRotation>) - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### TextSymbol

Source: https://pub.dev/documentation/google_mlkit_text_recognition/latest/google_mlkit_text_recognition

A text symbol recognized in an image. Represents a single symbol in an TextElement.

```APIDOC
## TextSymbol

### Description
A text symbol recognized in an image. Represents a single symbol in an TextElement.

### Properties
- **text** (String) - The text of the symbol.
- **boundingBox** (Rect) - The bounding box of the symbol.
- **recognizedLanguages** (List<String>) - The recognized languages.
- **confidence** (double?) - The confidence score.
- **angle** (double?) - The angle of the symbol.

```
Tokens:
Raw