Summary: Ctors | Methods | Inherited Methods

MultiResolutionImageReader.Builder

---

Kotlin |Java

public static final class MultiResolutionImageReader.Builder
extends Object

java.lang.Object
↳	android.hardware.camera2.MultiResolutionImageReader.Builder

---

Builder class for MultiResolutionImageReader objects.

Summary

Public constructors
Builder(Collection<MultiResolutionStreamInfo> streams, int format, int maxImages) Constructs a new builder for MultiResolutionImageReader.

Public methods
MultiResolutionImageReader	build() Build a new MultiResolutionImageReader object.
MultiResolutionImageReader.Builder	setConcurrentOutputsEnabled(boolean enable) Turn on/off concurrent outputs for the internal ImageReaders.
MultiResolutionImageReader.Builder	setUsage(long usage) Set the intended ERROR(usage/android.hardware.HardwareBuffer.Usage usage) of the images produced by the internal ImageReaders.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

public Builder (Collection<MultiResolutionStreamInfo> streams, 
                int format, 
                int maxImages)

Constructs a new builder for MultiResolutionImageReader.

See MultiResolutionImageReader(Collection,int,int,long) for detailed explanations of the constructor parameters.

Parameters
streams	Collection: The group of multi-resolution stream info returned from MultiResolutionStreamConfigurationMap.getOutputFormats(). This value cannot be null.
format	int: The format of the Image that this multi-resolution reader will produce. Value is one of the following: ImageFormat.UNKNOWN PixelFormat.RGBA_8888 PixelFormat.RGBX_8888 PixelFormat.RGB_888 ImageFormat.RGB_565 ImageFormat.YV12 ImageFormat.Y8 ImageFormat.YCBCR_P010 ImageFormat.YCBCR_P210 ImageFormat.NV16 ImageFormat.NV21 ImageFormat.YUY2 ImageFormat.JPEG ImageFormat.DEPTH_JPEG ImageFormat.YUV_420_888 ImageFormat.YUV_422_888 ImageFormat.YUV_444_888 ImageFormat.FLEX_RGB_888 ImageFormat.FLEX_RGBA_8888 ImageFormat.RAW_SENSOR ImageFormat.RAW_PRIVATE ImageFormat.RAW10 ImageFormat.RAW12 ImageFormat.RAW14 ImageFormat.DEPTH16 ImageFormat.DEPTH_POINT_CLOUD ImageFormat.PRIVATE ImageFormat.HEIC ImageFormat.HEIC_ULTRAHDR ImageFormat.JPEG_R
maxImages	int: The maximum number of images the user will want to access simultaneously. Value is 1 or greater

Public methods

build

public MultiResolutionImageReader build ()

Build a new MultiResolutionImageReader object.

Returns
MultiResolutionImageReader	The new MultiResolutionImageReader object. This value cannot be null.

setConcurrentOutputsEnabled

public MultiResolutionImageReader.Builder setConcurrentOutputsEnabled (boolean enable)

Turn on/off concurrent outputs for the internal ImageReaders.

If ERROR(/MultiResolutionStreamConfigurationMap#isConcurrentReadersSupported) returns true, the camera device supports concurrent outputs from multiple internal ImageReaders (for example, in scenarios where multiple sensors run at the same time). By default, concurrent outputs are disabled. The application can enable such mode by calling this function with true.

Parameters
enable	boolean: Whether to allow the camera device to output concurrent readers for this MultiResolutionImageReader. If set to true for a device that doesn't support MultiResolutionImageReader concurrency, CameraDevice.createCaptureSession(SessionConfiguration) will fail.

Returns
MultiResolutionImageReader.Builder	the Builder instance with concurrency enabled. This value cannot be null.

setUsage

public MultiResolutionImageReader.Builder setUsage (long usage)

Set the intended ERROR(usage/android.hardware.HardwareBuffer.Usage usage) of the images produced by the internal ImageReaders.

The default usage is HardwareBuffer.USAGE_CPU_READ_OFTEN, unless the format is ImageFormat.PRIVATE, in which case the default usage is 0.

Parameters

usage

long: The intended ERROR(usage/android.hardware.HardwareBuffer.Usage usage) of the images produced by the internal ImageReaders. Value is either 0 or a combination of the following: HardwareBuffer.USAGE_CPU_READ_RARELY HardwareBuffer.USAGE_CPU_READ_OFTEN HardwareBuffer.USAGE_CPU_WRITE_RARELY HardwareBuffer.USAGE_CPU_WRITE_OFTEN HardwareBuffer.USAGE_GPU_SAMPLED_IMAGE HardwareBuffer.USAGE_GPU_COLOR_OUTPUT HardwareBuffer.USAGE_COMPOSER_OVERLAY HardwareBuffer.USAGE_PROTECTED_CONTENT HardwareBuffer.USAGE_VIDEO_ENCODE HardwareBuffer.USAGE_GPU_DATA_BUFFER HardwareBuffer.USAGE_SENSOR_DIRECT_DATA HardwareBuffer.USAGE_GPU_CUBE_MAP HardwareBuffer.USAGE_GPU_MIPMAP_COMPLETE HardwareBuffer.USAGE_FRONT_BUFFER

Returns
MultiResolutionImageReader.Builder	the Builder instance with customized usage value. This value cannot be null.