Class CutoutConfig
-
- All Implemented Interfaces:
public class CutoutConfig
Schema for SDK Cutout Configuration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
CutoutConfig.Alignment
The alignment of the cutout area.
public enum
CutoutConfig.Animation
Animation type for the cutout when initially displayed. Values: none, fade, zoom
-
Field Summary
Fields Modifier and Type Field Description public CutoutConfig.Alignment
alignment
public Integer
width
public String
maxWidthPercent
public String
maxHeightPercent
public RatioFromSize
ratioFromSize
public Integer
strokeWidth
public String
strokeColor
public String
feedbackStrokeColor
public Integer
cornerRadius
public String
outerColor
public Double
outerAlpha
public Offset
offset
public CutoutConfig.Animation
animation
public Offset
cropPadding
public Offset
cropOffset
-
Constructor Summary
Constructors Constructor Description CutoutConfig()
-
Method Summary
Modifier and Type Method Description CutoutConfig.Alignment
getAlignment()
The alignment of the cutout area. void
setAlignment(CutoutConfig.Alignment alignment)
The alignment of the cutout area. Integer
getWidth()
The preferred width in pixels, relating to the camera resolution. void
setWidth(Integer width)
The preferred width in pixels, relating to the camera resolution. String
getMaxWidthPercent()
The maximum width in percent (0-100), relating to the size of the view. void
setMaxWidthPercent(String maxWidthPercent)
The maximum width in percent (0-100), relating to the size of the view. String
getMaxHeightPercent()
The maximum height in percent (0-100), relating to the size of the view. void
setMaxHeightPercent(String maxHeightPercent)
The maximum height in percent (0-100), relating to the size of the view. RatioFromSize
getRatioFromSize()
A size constraining the ratio of width / height. void
setRatioFromSize(RatioFromSize ratioFromSize)
A size constraining the ratio of width / height. Integer
getStrokeWidth()
The stroke width of the cutout. void
setStrokeWidth(Integer strokeWidth)
The stroke width of the cutout. String
getStrokeColor()
The hex string (RRGGBB) of the stroke color. void
setStrokeColor(String strokeColor)
The hex string (RRGGBB) of the stroke color. String
getFeedbackStrokeColor()
The hex string (RRGGBB) of the stroke color for visual feedback. void
setFeedbackStrokeColor(String feedbackStrokeColor)
The hex string (RRGGBB) of the stroke color for visual feedback. Integer
getCornerRadius()
Radius of the corners of the cutout. void
setCornerRadius(Integer cornerRadius)
Radius of the corners of the cutout. String
getOuterColor()
Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string. void
setOuterColor(String outerColor)
Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string. Double
getOuterAlpha()
Optional transparency factor for the outer color (0.0 - 1.0). void
setOuterAlpha(Double outerAlpha)
Optional transparency factor for the outer color (0.0 - 1.0). Offset
getOffset()
An optional offset (in dp) for the elements. void
setOffset(Offset offset)
An optional offset (in dp) for the elements. CutoutConfig.Animation
getAnimation()
Animation type for the cutout when initially displayed. void
setAnimation(CutoutConfig.Animation animation)
Animation type for the cutout when initially displayed. Offset
getCropPadding()
An optional offset (in dp) for the elements. void
setCropPadding(Offset cropPadding)
An optional offset (in dp) for the elements. Offset
getCropOffset()
An optional offset (in dp) for the elements. void
setCropOffset(Offset cropOffset)
An optional offset (in dp) for the elements. String
toString()
int
hashCode()
boolean
equals(Object other)
-
-
Method Detail
-
getAlignment
CutoutConfig.Alignment getAlignment()
The alignment of the cutout area.
-
setAlignment
void setAlignment(CutoutConfig.Alignment alignment)
The alignment of the cutout area.
-
getWidth
Integer getWidth()
The preferred width in pixels, relating to the camera resolution. If not specified or 0, the maximum possible width will be chosen.
-
setWidth
void setWidth(Integer width)
The preferred width in pixels, relating to the camera resolution. If not specified or 0, the maximum possible width will be chosen.
-
getMaxWidthPercent
String getMaxWidthPercent()
The maximum width in percent (0-100), relating to the size of the view.
-
setMaxWidthPercent
void setMaxWidthPercent(String maxWidthPercent)
The maximum width in percent (0-100), relating to the size of the view.
-
getMaxHeightPercent
String getMaxHeightPercent()
The maximum height in percent (0-100), relating to the size of the view.
-
setMaxHeightPercent
void setMaxHeightPercent(String maxHeightPercent)
The maximum height in percent (0-100), relating to the size of the view.
-
getRatioFromSize
RatioFromSize getRatioFromSize()
A size constraining the ratio of width / height. If set to 0, the ratio will be equal to the full frame.
-
setRatioFromSize
void setRatioFromSize(RatioFromSize ratioFromSize)
A size constraining the ratio of width / height. If set to 0, the ratio will be equal to the full frame.
-
getStrokeWidth
Integer getStrokeWidth()
The stroke width of the cutout. If set to 0, the line will be invisible.
-
setStrokeWidth
void setStrokeWidth(Integer strokeWidth)
The stroke width of the cutout. If set to 0, the line will be invisible.
-
getStrokeColor
String getStrokeColor()
The hex string (RRGGBB) of the stroke color. (e.g. 00CCFF).
-
setStrokeColor
void setStrokeColor(String strokeColor)
The hex string (RRGGBB) of the stroke color. (e.g. 00CCFF).
-
getFeedbackStrokeColor
String getFeedbackStrokeColor()
The hex string (RRGGBB) of the stroke color for visual feedback. (e.g. 00CCFF).
-
setFeedbackStrokeColor
void setFeedbackStrokeColor(String feedbackStrokeColor)
The hex string (RRGGBB) of the stroke color for visual feedback. (e.g. 00CCFF).
-
getCornerRadius
Integer getCornerRadius()
Radius of the corners of the cutout.
-
setCornerRadius
void setCornerRadius(Integer cornerRadius)
Radius of the corners of the cutout.
-
getOuterColor
String getOuterColor()
Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string.
-
setOuterColor
void setOuterColor(String outerColor)
Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string.
-
getOuterAlpha
Double getOuterAlpha()
Optional transparency factor for the outer color (0.0 - 1.0).
-
setOuterAlpha
void setOuterAlpha(Double outerAlpha)
Optional transparency factor for the outer color (0.0 - 1.0).
-
getAnimation
CutoutConfig.Animation getAnimation()
Animation type for the cutout when initially displayed. Values: none, fade, zoom
-
setAnimation
void setAnimation(CutoutConfig.Animation animation)
Animation type for the cutout when initially displayed. Values: none, fade, zoom
-
getCropPadding
Offset getCropPadding()
An optional offset (in dp) for the elements.
-
setCropPadding
void setCropPadding(Offset cropPadding)
An optional offset (in dp) for the elements.
-
getCropOffset
Offset getCropOffset()
An optional offset (in dp) for the elements.
-
setCropOffset
void setCropOffset(Offset cropOffset)
An optional offset (in dp) for the elements.
-
hashCode
int hashCode()
-
-
-
-