ImageProxy
@RequiresApi(value = 21)
public interface ImageProxy extends AutoCloseable
An image proxy which has a similar interface as android.media.Image.
Summary
Nested types |
|
|---|---|
public interface ImageProxy.PlaneProxy |
A plane proxy which has an analogous interface as |
Public methods |
|
|---|---|
abstract void |
close()Closes the underlying |
abstract @NonNull Rect |
Returns the crop rectangle. |
abstract int |
Returns the image format. |
abstract int |
Returns the image height. |
abstract @Nullable Image |
Returns the android |
abstract @NonNull ImageInfo |
Returns the |
abstract @NonNull ImageProxy.PlaneProxy[] |
Returns the array of planes. |
abstract int |
getWidth()Returns the image width. |
abstract void |
setCropRect(@Nullable Rect rect)Sets the crop rectangle. |
Public methods
getFormat
abstract int getFormat()
Returns the image format.
The image format can be one of the android.graphics.ImageFormat or android.graphics.PixelFormat constants.
| See also | |
|---|---|
getFormat |
getImage
@ExperimentalGetImage
abstract @Nullable Image getImage()
Returns the android Image.
If the ImageProxy is a wrapper for an android Image, it will return the Image. It is possible for an ImageProxy to wrap something that isn't an Image. If that's the case then it will return null.
The returned image should not be closed by the application. Instead it should be closed by the ImageProxy, which happens, for example, on return from the ImageAnalysis.Analyzer function. Destroying the ImageAnalysis will close the underlying android.media.ImageReader. So an Image obtained with this method will behave as such.
| See also | |
|---|---|
close |
getPlanes
abstract @NonNull ImageProxy.PlaneProxy[] getPlanes()
Returns the array of planes.
| See also | |
|---|---|
getPlanes |
setCropRect
abstract void setCropRect(@Nullable Rect rect)
Sets the crop rectangle.
| See also | |
|---|---|
setCropRect |