HardwareBufferFrame

Kotlin |Java

@ExperimentalApi
public interface HardwareBufferFrame extends Frame

A Frame backed by a HardwareBuffer.

Summary

Nested types
`public interface HardwareBufferFrame.Builder` A Builder for `HardwareBufferFrame` instances.

Public methods
`abstract HardwareBufferFrame.Builder`	`buildUpon()` Returns a `Builder` initialized with the values of this instance.
`abstract HardwareBuffer`	`@RequiresApi(value = 26) getHardwareBuffer()` Returns the `HardwareBuffer` backing this frame.

`default static final String`	`KEY_DISPLAY_TIME_NS = "KEY_DISPLAY_TIME_NS"` Metadata key for storing the system time that this frame should be displayed at to maintain A/V sync.
`default static final String`	`KEY_PRESENTATION_TIME_US = "KEY_PRESENTATION_TIME_US"` Metadata key for storing the composition presentation time of this frame, in microseconds.
`default static final long`	`USAGE_COMPOSER_OVERLAY = 2048` The frame will be used as a hardware composer overlay layer.
`default static final long`	`USAGE_CPU_READ_OFTEN = 3` The frame will often be read by the CPU.
`default static final long`	`USAGE_CPU_READ_RARELY = 2` The frame will sometimes be read by the CPU.
`default static final long`	`USAGE_CPU_WRITE_OFTEN = 48` The frame will often be written to by the CPU.
`default static final long`	`USAGE_CPU_WRITE_RARELY = 32` The frame will sometimes be written to by the CPU.
`default static final long`	`USAGE_GPU_COLOR_OUTPUT = 512` The frame will be written to by the GPU.
`default static final long`	`USAGE_GPU_SAMPLED_IMAGE = 256` The frame will be read from by the GPU.
`default static final long`	`USAGE_VIDEO_ENCODE = 65536` The frame will be read by a hardware video encoder.

`abstract long`	`getContentTimeUs()` The time of the frame in the context of the input media in microseconds, or `TIME_UNSET` if it is not set.
`abstract Format`	`getFormat()` The frame format.
`abstract ImmutableMap<String, Object>`	`getMetadata()` The frame metadata.

abstract HardwareBufferFrame.Builder buildUpon()

Returns a Builder initialized with the values of this instance.

Returns
`HardwareBufferFrame.Builder`	A `Builder` that can be used to create a modified copy of this frame.

@RequiresApi(value = 26)
abstract HardwareBuffer getHardwareBuffer()

Returns the HardwareBuffer backing this frame.

Returns
`HardwareBuffer`	The underlying `HardwareBuffer`.