ImageProxy.PlaneProxy


interface ImageProxy.PlaneProxy : ImagePlane


A plane proxy which has an analogous interface as android.media.Image.Plane.

Summary

Public functions

ByteBuffer

Returns the pixels buffer.

Int

Returns the pixel stride.

Int

Returns the row stride.

T?
<T> unwrapAs(type: Class<T!>)

Attempts to unwrap this object into the specified underlying type.

Public functions

getBuffer

Added in 1.0.0
fun getBuffer(): ByteBuffer

Returns the pixels buffer.

See also
getBuffer

getPixelStride

Added in 1.0.0
fun getPixelStride(): Int

Returns the pixel stride.

See also
getPixelStride

getRowStride

Added in 1.0.0
fun getRowStride(): Int

Returns the row stride.

See also
getRowStride

unwrapAs

Added in 1.7.0-alpha03
fun <T> unwrapAs(type: Class<T!>): T?

Attempts to unwrap this object into the specified underlying type.

Callers should use this method to retrieve the wrapped platform object.

Implementation Notes

  • If the requested type is not supported by this wrapper, this method must return null.

  • Implementations designed for testing (e.g., fakes, mocks, or no-op wrappers) should return null to signal that no real underlying object is available.

Parameters
<T>

The expected type of the underlying object.

type: Class<T!>

The Class representing the expected type of the underlying object.

Returns
T?

The underlying object cast to T, or null if the object cannot be unwrapped into the requested type.