FrameInfo.Builder

Kotlin |Java

class FrameInfo.Builder

A builder for FrameInfo instances.

Summary

Public constructors
`Builder(frameInfo: FrameInfo!)` Creates an instance with the values of the provided `FrameInfo`.
`Builder(colorInfo: ColorInfo!, width: Int, height: Int)` Creates an instance with default values.

Public functions
`FrameInfo!`	`build()` Builds a `FrameInfo` instance.
`FrameInfo.Builder!`	`@CanIgnoreReturnValue setColorInfo(colorInfo: ColorInfo!)` Sets the `ColorInfo`.
`FrameInfo.Builder!`	`@CanIgnoreReturnValue setHeight(height: Int)` Sets the frame height, in pixels.
`FrameInfo.Builder!`	`@CanIgnoreReturnValue setOffsetToAddUs(offsetToAddUs: Long)` Sets the `offset to add` to the frame presentation timestamp, in microseconds.
`FrameInfo.Builder!`	`@CanIgnoreReturnValue setPixelWidthHeightRatio(pixelWidthHeightRatio: Float)` Sets the ratio of width over height for each pixel.
`FrameInfo.Builder!`	`@CanIgnoreReturnValue setWidth(width: Int)` Sets the frame width, in pixels.

Builder(frameInfo: FrameInfo!)

Creates an instance with the values of the provided FrameInfo.

Builder(colorInfo: ColorInfo!, width: Int, height: Int)

Creates an instance with default values.

fun build(): FrameInfo!

Builds a FrameInfo instance.

@CanIgnoreReturnValue
fun setColorInfo(colorInfo: ColorInfo!): FrameInfo.Builder!

Sets the ColorInfo.

@CanIgnoreReturnValue
fun setHeight(height: Int): FrameInfo.Builder!

Sets the frame height, in pixels.

@CanIgnoreReturnValue
fun setOffsetToAddUs(offsetToAddUs: Long): FrameInfo.Builder!

Sets the offset to add to the frame presentation timestamp, in microseconds.

The default value is 0.

@CanIgnoreReturnValue
fun setPixelWidthHeightRatio(pixelWidthHeightRatio: Float): FrameInfo.Builder!

Sets the ratio of width over height for each pixel.

The default value is 1.

@CanIgnoreReturnValue
fun setWidth(width: Int): FrameInfo.Builder!

Sets the frame width, in pixels.