CaptureFlash enum

Whether Participant.captureImage lights the scene before it grabs the frame.

Example

final base64Image = await room.localParticipant.captureImage(
  flash: CaptureFlash.ON,
);
Inheritance
Available extensions

Values

OFF → const CaptureFlash

Captures the frame as it is.

ON → const CaptureFlash

Lights the scene first and adds about half a second to the capture.

  • Uses the camera's torch when it has one, which covers most back cameras.
  • A front camera without a torch lights the screen when VideoSDK.setScreenFlash is on; otherwise the image is captured unlit.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<CaptureFlash>
A constant List of the values in this enum, in order of their declaration.