# ImplementationMode

Artifact: [androidx.camera.viewfinder:viewfinder-core](https://developer.android.com/jetpack/androidx/releases/camera-viewfinder) [View Source](https://cs.android.com/search?q=file:androidx/camera/viewfinder/core/ImplementationMode.kt+class:androidx.camera.viewfinder.core.ImplementationMode) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera-viewfinder#1.5.0)

*** ** * ** ***


```
enum ImplementationMode : Enum<ImplementationMode>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[ImplementationMode](https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode)\> ||
|   | ↳ | [androidx.camera.viewfinder.core.ImplementationMode](https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode) |

*** ** * ** ***

The implementation mode of a Viewfinder.

User preference on how the viewfinder should render the viewfinder. The viewfinder is displayed with either a SurfaceView/AndroidExternalSurface or a TextureView/AndroidEmbeddedExternalSurface.

- `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#EXTERNAL` uses a SurfaceView/AndroidExternalSurface, it is generally better when it comes to certain key metrics, including power and latency.

- `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#EMBEDDED` uses a TextureView/AndroidEmbeddedExternalSurface it is better supported by a wider range of devices.

The option is used to decide what is the best internal implementation given the device capabilities and user configurations.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#EMBEDDED` | Use a TextureView/AndroidEmbeddedExternalSurface for the Viewfinder. |
| `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#EXTERNAL` | Use a SurfaceView/AndroidExternalSurface for the Viewfinder when possible. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode` | `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode>` | `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode>` | `https://developer.android.com/reference/kotlin/androidx/camera/viewfinder/core/ImplementationMode#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. |

## Enum Values

### EMBEDDED

```
val ImplementationMode.EMBEDDED: ImplementationMode
```

Use a TextureView/AndroidEmbeddedExternalSurface for the Viewfinder.

### EXTERNAL

```
val ImplementationMode.EXTERNAL: ImplementationMode
```

Use a SurfaceView/AndroidExternalSurface for the Viewfinder when possible. It has somewhat lower latency and less performance and power overhead. It offers more control on a single drawing board, but does not support certain animations.

## Public functions

### valueOf

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera-viewfinder#1.5.0)

```
fun valueOf(value: String): ImplementationMode
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera-viewfinder#1.5.0)

```
fun values(): Array<ImplementationMode>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.

## Public properties

### entries

```
val entries: EnumEntries<ImplementationMode>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.