Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/media/ImageWriter.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/media/ImageWriter.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/ImageWriter.Builder#inhmethods)

# ImageWriter.Builder

*** ** * ** ***

` public static final class ImageWriter.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.ImageWriter.Builder |

<br />

*** ** * ** ***

Builder class for `https://developer.android.com/reference/android/media/ImageWriter` objects.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder#Builder(android.view.Surface)(https://developer.android.com/reference/android/view/Surface surface) ` Constructs a new builder for `https://developer.android.com/reference/android/media/ImageWriter`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/ImageWriter` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#build()() ` Builds a new ImageWriter object. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setDataSpace(int)(int dataSpace) ` Set the dataspace of this ImageWriter. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setHardwareBufferFormat(int)(int hardwareBufferFormat) ` Set the hardwareBuffer format of this ImageWriter. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setImageFormat(int)(int imageFormat) ` Set the image format of this ImageWriter. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setMaxImages(int)(int maxImages) ` Set the maximum number of images. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setUsage(long)(long usage) ` Set the usage flag of this ImageWriter. |
| ` https://developer.android.com/reference/android/media/ImageWriter.Builder` | ` https://developer.android.com/reference/android/media/ImageWriter.Builder#setWidthAndHeight(int,%20int)(int width, int height) ` Set the width and height of images. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### Builder

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Builder (Surface surface)
```

Constructs a new builder for `https://developer.android.com/reference/android/media/ImageWriter`.

<br />

| Parameters ||
|---|---|
| `surface` | `Surface`: The destination Surface this writer produces Image data into. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the surface is already abandoned. |

## Public methods

### build

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter build ()
```

Builds a new ImageWriter object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter` | The new ImageWriter object. This value cannot be `null`. <br /> |

### setDataSpace

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setDataSpace (int dataSpace)
```

Set the dataspace of this ImageWriter. The default value is `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_UNKNOWN`.

<br />

| Parameters ||
|---|---|
| `dataSpace` | `int`: The dataspace of the image that this writer will produce. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DEPTH` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DYNAMIC_DEPTH` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_HEIF` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_HEIF_ULTRAHDR` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_JPEG_R` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_UNKNOWN` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SCRGB_LINEAR` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SRGB` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SCRGB` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DISPLAY_P3` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020_HLG` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020_PQ` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_ADOBE_RGB` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_JFIF` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT601_625` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT601_525` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT709` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DCI_P3` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SRGB_LINEAR` - `https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DISPLAY_BT2020` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the builder instance with customized dataspace value. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/ImageWriter.Builder#setHardwareBufferFormat(int)`

### setHardwareBufferFormat

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setHardwareBufferFormat (int hardwareBufferFormat)
```

Set the hardwareBuffer format of this ImageWriter. The default value is `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_8888`.

This function works together with `https://developer.android.com/reference/android/media/ImageWriter.Builder#setDataSpace(int)` for an `https://developer.android.com/reference/android/media/ImageWriter` instance. Setting at least one of these two replaces `https://developer.android.com/reference/android/media/ImageWriter.Builder#setImageFormat(int)` function.

<br />

<br />

| Parameters ||
|---|---|
| `hardwareBufferFormat` | `int`: The HardwareBuffer format of the image that this writer will produce. Value is one of the following: - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_8888` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_FP16` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_1010102` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBX_8888` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGB_888` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGB_565` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#BLOB` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_420_888` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#D_16` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#D_24` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#DS_24UI8` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#D_FP32` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#DS_FP32UI8` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#S_UI8` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_P010` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_P210` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#R_8` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#R_16` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RG_1616` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_10101010` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#R_12` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#R_14` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RG_1212` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RG_1414` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_12121212` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_14141414` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#BGRA_1010102` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#BGRX_1010102` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the Builder instance with customized buffer format. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/ImageWriter.Builder#setDataSpace(int)`
- `https://developer.android.com/reference/android/media/ImageWriter.Builder#setImageFormat(int)`

### setImageFormat

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setImageFormat (int imageFormat)
```

Set the image format of this ImageWriter. Default format depends on the Surface provided.

<br />

| Parameters ||
|---|---|
| `imageFormat` | `int`: The format of the `https://developer.android.com/reference/android/media/ImageWriter`. It can be any valid specified by `https://developer.android.com/reference/android/graphics/ImageFormat` or `https://developer.android.com/reference/android/graphics/PixelFormat`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the Builder instance with customized image format. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `imageFormat` is invalid. |

### setMaxImages

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setMaxImages (int maxImages)
```

Set the maximum number of images. Default value is 1.

<br />

| Parameters ||
|---|---|
| `maxImages` | `int`: The maximum number of Images the user will want to access simultaneously for producing Image data. Value is 1 or greater <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the Builder instance with customized usage value. This value cannot be `null`. <br /> |

### setUsage

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setUsage (long usage)
```

Set the usage flag of this ImageWriter.

If this function is not called, usage bit will be set to `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_CPU_WRITE_OFTEN` if the image format is not `https://developer.android.com/reference/android/graphics/ImageFormat#PRIVATE`.

<br />

<br />

| Parameters ||
|---|---|
| `usage` | `long`: The intended usage of the images produced by this ImageWriter. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_CPU_READ_RARELY` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_CPU_READ_OFTEN` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_CPU_WRITE_RARELY` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_CPU_WRITE_OFTEN` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_GPU_SAMPLED_IMAGE` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_GPU_COLOR_OUTPUT` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_COMPOSER_OVERLAY` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_PROTECTED_CONTENT` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_VIDEO_ENCODE` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_GPU_DATA_BUFFER` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_SENSOR_DIRECT_DATA` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_GPU_CUBE_MAP` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_GPU_MIPMAP_COMPLETE` - `https://developer.android.com/reference/android/hardware/HardwareBuffer#USAGE_FRONT_BUFFER` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the Builder instance with customized usage flag. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/hardware/HardwareBuffer`
- `https://developer.android.com/reference/android/media/ImageWriter#getUsage()`

### setWidthAndHeight

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageWriter.Builder setWidthAndHeight (int width, 
                int height)
```

Set the width and height of images. Default size is dependent on the Surface that is provided by the downstream end-point.

<br />

| Parameters ||
|---|---|
| `width` | `int`: The width in pixels that will be passed to the producer. Value is 1 or greater <br /> |
| `height` | `int`: The height in pixels that will be passed to the producer. Value is 1 or greater <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/ImageWriter.Builder` | the Builder instance with customized width and height. This value cannot be `null`. <br /> |