videosdk-android-sdk/live.videosdk.rtc.android/CaptureFlash

CaptureFlash

enum CaptureFlash : Enum<CaptureFlash>

Whether Participant.captureImage lights the scene for the capture.

With ON the SDK uses the camera's flash unit when it has one, which covers most back cameras. A front camera without one uses the ScreenFlash set with VideoSDK.setScreenFlash; with none set, the image is captured unlit.

Entries

Link copied to clipboard
OFF

The image is captured with no added light.

Link copied to clipboard
ON

Adds about half a second to the capture while the exposure adjusts to the light.

Properties

Link copied to clipboard
val entries: EnumEntries<CaptureFlash>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

Link copied to clipboard
fun valueOf(value: String): CaptureFlash

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

Link copied to clipboard
fun values(): Array<CaptureFlash>

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