Image.Plane

extends Object

java.lang.Object
↳	android.media.Image.Plane

Class Overview

A single color plane of image data.

The number and meaning of the planes in an Image are determined by the format of the Image.

Once the Image has been closed, any access to the the plane's ByteBuffer will fail.

Summary

Public Methods
abstract ByteBuffer	getBuffer() Get a direct `ByteBuffer` containing the frame data.
abstract int	getPixelStride() The distance between adjacent pixel samples, in bytes.
abstract int	getRowStride() The row stride for this color plane, in bytes.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public abstract ByteBuffer getBuffer ()

Added in API level 19

Get a direct ByteBuffer containing the frame data.

In particular, the buffer returned will always have isDirect return true, so the underlying data could be mapped as a pointer in JNI without doing any copies with GetDirectBufferAddress.

For raw formats, each plane is only guaranteed to contain data up to the last pixel in the last row. In other words, the stride after the last row may not be mapped into the buffer. This is a necessary requirement for any interleaved format.

Returns

the byte buffer containing the image data for this plane.

public abstract int getPixelStride ()

Added in API level 19

The distance between adjacent pixel samples, in bytes.

This is the distance between two consecutive pixel values in a row of pixels. It may be larger than the size of a single pixel to account for interleaved image data or padded formats. The pixel stride is always greater than 0.

public abstract int getRowStride ()

Added in API level 19

The row stride for this color plane, in bytes.

This is the distance between the start of two consecutive rows of pixels in the image. The row stride is always greater than 0.

Results

Interfaces

Classes

Exceptions

Image.Plane

Class Overview

See Also

Summary

Public Methods

public abstract ByteBuffer getBuffer ()

Returns

public abstract int getPixelStride ()

public abstract int getRowStride ()