PreviewView.StreamState

enum PreviewView.StreamState


Definitions for the preview stream state.

Summary

Enum Values

IDLE

Preview is not visible yet.

STREAMING

Preview is streaming.

Public functions

java-static PreviewView.StreamState!
valueOf(name: String!)

Returns the enum constant of this type with the specified name.

java-static Array<PreviewView.StreamState!>!

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

Enum Values

IDLE

val PreviewView.StreamState.IDLEPreviewView.StreamState

Preview is not visible yet.

STREAMING

val PreviewView.StreamState.STREAMINGPreviewView.StreamState

Preview is streaming.

This state only guarantees the preview is streaming when the implementation mode is COMPATIBLE. When in PERFORMANCE mode, it is possible that the preview becomes visible slightly after the state has changed. For apps requiring a precise signal for when the preview starts, please set COMPATIBLE mode via setImplementationMode.

Public functions

valueOf

Added in 1.1.0
java-static fun valueOf(name: String!): PreviewView.StreamState!

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.)

Returns
PreviewView.StreamState!

the enum constant with the specified name

Throws
java.lang.IllegalArgumentException

if this enum type has no constant with the specified name

values

Added in 1.1.0
java-static fun values(): Array<PreviewView.StreamState!>!

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.

Returns
Array<PreviewView.StreamState!>!

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