ImageManager
The ImageManager class is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images.
Definition
Namespace: com.dynamsoft.utility
Assembly: DynamsoftUtility.aar
class ImageManager
Methods
| Method | Description |
|---|---|
saveToFile |
Saves an image to the specified path and format. |
drawOnImage(imageData,quads,colour,thickness) |
Add quadrilaterals on the image. |
drawOnImage(imageData,lines,colour,thickness) |
Add lines on the image. |
drawOnImage(imageData,contours,colour,thickness) |
Add contours on the image. |
drawOnImage(imageData,corners,colour,thickness) |
Add corners on the image. |
drawOnImage(imageData,edges,colour,thickness) |
Add edges on the image. |
saveToFile
Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the path parameter.
void saveToFile(ImageData imageData, String path, boolean overWrite) throws UtilityException{}
Parameters
[in] imageData: The image to be saved, of type ImageData.
[in] path: The file path, name and extension name, as a string, under which the image will be saved.
[in] overWrite: A flag indicating whether to overwrite the file if it already exists. Defaults to true.
Exception
| Error Code | Value | Description |
|---|---|---|
| EC_NULL_POINTER | -10002 | The ImageData object is null. |
| EC_FILE_TYPE_NOT_SUPPORTED | -10006 | The file type is not supported. |
| EC_FILE_ALREADY_EXISTS | -10067 | The file already exists but overwriting is disabled. |
| EC_CREATE_FILE_FAILED | -10068 | The file path does not exist but cannot be created, or the file cannot be created for any other reason. |
| EC_IMGAE_DATA_INVALID | -10069 | The input ImageData object contains invalid parameter(s). |
Return Value
A boolean value that indicates whether the file is saved successfully.
Code Snippet
@Override
public void onOriginalImageResultReceived(@NonNull OriginalImageResultItem result) {
if (result != null)
{
ImageManager imageManager = new ImageManager();
Thread saveThread = new Thread(new Runnable() {
@Override
public void run() {
try {
imageManager.saveToFile(result.getImageData(), String.valueOf(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES))+"/DynamsoftImageManager/originalImage.png", true);
} catch (UtilityException e) {
throw new RuntimeException(e);
} catch (CoreException e) {
throw new RuntimeException(e);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
});
saveThread.start();
} else {
Log.i("CRR", "onOriginalImageResultReceived: Not saved");
return;
}
}
drawOnImage(imageData,quads,colour,thickness)
Add quadrilaterals on the image.
ImageData drawOnImage(ImageData imageData, Quadrilateral[] quads, int colour, int thickness){}
Parameters
[in] imageData: The ImageData to modify.
[in] quads: An array of Quadrilateral objects to be added on the image.
[in] colour: An int value as an ARGB colour.
[in] thickness: The width of the border.
Return Value
The modified ImageData.
drawOnImage(imageData,lineSegments,colour,thickness)
Add lines on the image.
ImageData drawOnImage(ImageData imageData, LineSegment[] lines, int colour, int thickness){}
Parameters
[in] imageData: The ImageData to modify.
[in] lineSegments: An array of LineSegment objects to be added on the image.
[in] colour: An int value as an ARGB colour.
[in] thickness: The width of the lines.
Return Value
The modified ImageData.
drawOnImage(imageData,contours,colour,thickness)
Add contours on the image.
ImageData drawOnImage(ImageData imageData, Contour[] contours, int colour, int thickness){}
Parameters
[in] imageData: The ImageData to modify.
[in] contours: An array of Contour objects to be added on the image.
[in] colour: An int value as an ARGB colour.
[in] thickness: The width of the borders.
Return Value
The modified ImageData.
drawOnImage(imageData,corners,colour,thickness)
Add corners on the image.
ImageData drawOnImage(ImageData imageData, Corner[] corners, int colour, int thickness){}
Parameters
[in] imageData: The ImageData to modify.
[in] corners: An array of Corner objects to be added on the image.
[in] colour: An int value as an ARGB colour.
[in] thickness: The width of the lines.
Return Value
The modified ImageData.
drawOnImage(imageData,edges,colour,thickness)
Add edges on the image.
ImageData drawOnImage(ImageData imageData, Edge[] edges, int colour, int thickness){}
Parameters
[in] imageData: The ImageData to modify.
[in] edges: An array of Edge objects to be added on the image.
[in] colour: An int value as an ARGB colour.
[in] thickness: The width of the lines.
Return Value
The modified ImageData.
Yes
No