Text.Symbol
Stay organized with collections
Save and categorize content based on your preferences.
Represents a single symbol in an Text.Element.
Note that such field is not available for unbundled versions of Text Recognition library
yet.
Public Method Summary
| float |
getAngle()
Gets the angle(in degrees, clockwise is positive, range is [-180, 180]) of the
rotation of the recognized line.
|
|
Rect
|
getBoundingBox()
Returns the axis-aligned bounding rectangle of the detected text.
|
| float |
|
|
Point[]
|
getCornerPoints()
Gets the four corner points in clockwise direction starting with top-left.
|
|
String
|
|
|
String
|
|
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Methods
public float getAngle ()
Gets the angle(in degrees, clockwise is positive, range is [-180, 180]) of the
rotation of the recognized line.
public Rect getBoundingBox ()
Returns the axis-aligned bounding rectangle of the detected text. If nothing found,
it returns null.
public float getConfidence ()
Gets the confidence of the recognized element.
It is in range [0.0f, 1.0f].
Note that this information will be unavailable (i.e. returns 0) if you're using the
unbundled version of Text Recognition library with an older version of Google Play
services (lower than 22.30.XX).
public Point[]
getCornerPoints ()
Gets the four corner points in clockwise direction starting with top-left. Due to
the possible perspective distortions, this is not necessarily a rectangle. Parts of the
region could be outside of the image. If nothing found, it returns
null.
public String getRecognizedLanguage ()
Gets prevailing language in the text, if any. The format is in BCP47 (e.g. "en" or
"sr-Latn-BA") or "und" if the language could not be determined.
public String getText ()
Gets the recognized text in the Text.Symbol.
The recognized text is in reading order for the language. For Latin, it is
left-to-right.
Returns an empty string if nothing is found.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eText.Symbol\u003c/code\u003e represents an individual character within a recognized text element in ML Kit's Text Recognition API.\u003c/p\u003e\n"],["\u003cp\u003eIt provides access to the symbol's properties such as its text content, bounding box, confidence score, angle, and corner points.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetRecognizedLanguage\u003c/code\u003e method can identify the prevailing language of the symbol, while \u003ccode\u003egetConfidence\u003c/code\u003e indicates the recognition's accuracy.\u003c/p\u003e\n"],["\u003cp\u003eThis class is unavailable in older, unbundled versions of the Text Recognition library.\u003c/p\u003e\n"]]],["`Text.Symbol` represents a single symbol in `Text.Element`. Key actions include retrieving text via `getText()`, bounding box with `getBoundingBox()`, confidence using `getConfidence()`, and corner points via `getCornerPoints()`. The rotation angle is obtained with `getAngle()`, and the language is determined using `getRecognizedLanguage()`. Confidence values range from 0.0 to 1.0. Certain features are unavailable in unbundled library versions. The text is retrieved in reading order.\n"],null,["# Text.Symbol\n\npublic static class **Text.Symbol** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nRepresents a single symbol in an [Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element).\nNote that such field is not available for unbundled versions of Text Recognition library\nyet. \n\n### Public Method Summary\n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| float | [getAngle](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getAngle())() Gets the angle(in degrees, clockwise is positive, range is \\[-180, 180\\]) of the rotation of the recognized line. |\n| [Rect](//developer.android.com/reference/android/graphics/Rect.html) | [getBoundingBox](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getBoundingBox())() Returns the axis-aligned bounding rectangle of the detected text. |\n| float | [getConfidence](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getConfidence())() Gets the confidence of the recognized element. |\n| [Point\\[\\]](//developer.android.com/reference/android/graphics/Point.html) | [getCornerPoints](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getCornerPoints())() Gets the four corner points in clockwise direction starting with top-left. |\n| [String](//developer.android.com/reference/java/lang/String.html) | [getRecognizedLanguage](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getRecognizedLanguage())() Gets prevailing language in the text, if any. |\n| [String](//developer.android.com/reference/java/lang/String.html) | [getText](/android/reference/com/google/mlkit/vision/text/Text.Symbol#getText())() Gets the recognized text in the [Text.Symbol](/android/reference/com/google/mlkit/vision/text/Text.Symbol). |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public float **getAngle** ()\n\nGets the angle(in degrees, clockwise is positive, range is \\[-180, 180\\]) of the\nrotation of the recognized line. \n\n#### public [Rect](//developer.android.com/reference/android/graphics/Rect.html) **getBoundingBox** ()\n\nReturns the axis-aligned bounding rectangle of the detected text. If nothing found,\nit returns `null`. \n\n#### public float **getConfidence** ()\n\nGets the confidence of the recognized element.\n\nIt is in range \\[0.0f, 1.0f\\].\n\nNote that this information will be unavailable (i.e. returns 0) if you're using the\nunbundled version of Text Recognition library with an older version of Google Play\nservices (lower than 22.30.XX). \n\n#### public [Point\\[\\]](//developer.android.com/reference/android/graphics/Point.html)\n**getCornerPoints** ()\n\nGets the four corner points in clockwise direction starting with top-left. Due to\nthe possible perspective distortions, this is not necessarily a rectangle. Parts of the\nregion could be outside of the image. If nothing found, it returns\n`null`. \n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getRecognizedLanguage** ()\n\nGets prevailing language in the text, if any. The format is in BCP47 (e.g. \"en\" or\n\"sr-Latn-BA\") or \"und\" if the language could not be determined. \n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getText** ()\n\nGets the recognized text in the [Text.Symbol](/android/reference/com/google/mlkit/vision/text/Text.Symbol).\n\nThe recognized text is in reading order for the language. For Latin, it is\nleft-to-right.\n\nReturns an empty string if nothing is found."]]
