ZoomState

Artifact: androidx.camera:camera-core

View Source

Added in 1.0.0

---

Kotlin |Java

interface ZoomState

---

An interface which contains the zoom related information from a camera.

Applications can retrieve an instance via getZoomState.

Summary

Public functions
Float	getLinearZoom() Returns the linearZoom which is in range [0..1].
Float	getMaxZoomRatio() Returns the maximum zoom ratio.
Float	getMinZoomRatio() Returns the minimum zoom ratio.
Float	getZoomRatio() Returns the zoom ratio.

Public functions

getLinearZoom

Added in 1.0.0

fun getLinearZoom(): Float

Returns the linearZoom which is in range [0..1].

LinearZoom 0 represents the minimum zoom while linearZoom 1.0 represents the maximum zoom.

getMaxZoomRatio

Added in 1.0.0

fun getMaxZoomRatio(): Float

Returns the maximum zoom ratio.

getMinZoomRatio

Added in 1.0.0

fun getMinZoomRatio(): Float

Returns the minimum zoom ratio.

Typically 1.0, but can be less than 1.0 if the camera device supports zoom-out (only on android 11 or later).

getZoomRatio

Added in 1.0.0

fun getZoomRatio(): Float

Returns the zoom ratio. The value is 1.0 by default.