public class TextFilter extends Filter
Constructor and Description |
---|
TextFilter() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
Double |
getAlpha()
If set, alpha blending for the text is applied.
|
Integer |
getBorderWidth()
Width of the border around the text
|
Boolean |
getBox()
If set to true a box is drawn around the text using the background color.
|
Integer |
getBoxBorderWidth()
The width of the box drawn around the text.
|
String |
getBoxColor()
The background color to be used for drawing the box.
|
Boolean |
getFixBounds()
If set to true, it will fix text coordinates to avoid clipping if necessary
|
TextFilterFont |
getFont()
Get font
|
String |
getFontColor()
The color to be used to draw the text
|
Integer |
getFontSize()
Font size to be used to draw the text
|
String |
getFontSizeExpression()
An expression for the Font size.
|
Integer |
getLineSpacing()
Line spacing of the border around the box in pixels
|
String |
getRate()
Video frame rate
|
String |
getShadowColor()
Color of the shadow
|
Integer |
getShadowX()
X offset of the shadow
|
Integer |
getShadowY()
Y offset of the shadow
|
String |
getText()
String to be drawn
|
String |
getTimecode()
If set, the timecode representation in \"hh:mm:ss[:;.]ff\" format will be applied.
|
String |
getX()
X position of the text.
|
String |
getY()
Y position of the text.
|
int |
hashCode() |
void |
setAlpha(Double alpha)
If set, alpha blending for the text is applied.
|
void |
setBorderWidth(Integer borderWidth)
Width of the border around the text
|
void |
setBox(Boolean box)
If set to true a box is drawn around the text using the background color.
|
void |
setBoxBorderWidth(Integer boxBorderWidth)
The width of the box drawn around the text.
|
void |
setBoxColor(String boxColor)
The background color to be used for drawing the box.
|
void |
setFixBounds(Boolean fixBounds)
If set to true, it will fix text coordinates to avoid clipping if necessary
|
void |
setFont(TextFilterFont font)
Set font
|
void |
setFontColor(String fontColor)
The color to be used to draw the text
|
void |
setFontSize(Integer fontSize)
Font size to be used to draw the text
|
void |
setFontSizeExpression(String fontSizeExpression)
An expression for the Font size.
|
void |
setLineSpacing(Integer lineSpacing)
Line spacing of the border around the box in pixels
|
void |
setRate(String rate)
Video frame rate
|
void |
setShadowColor(String shadowColor)
Color of the shadow
|
void |
setShadowX(Integer shadowX)
X offset of the shadow
|
void |
setShadowY(Integer shadowY)
Y offset of the shadow
|
void |
setText(String text)
String to be drawn
|
void |
setTimecode(String timecode)
If set, the timecode representation in \"hh:mm:ss[:;.]ff\" format will be applied.
|
void |
setX(String x)
X position of the text.
|
void |
setY(String y)
Y position of the text.
|
String |
toString() |
getCreatedAt, getCustomData, getDescription, getModifiedAt, getName, putCustomDataItem, setCustomData, setDescription, setName
getId
public TextFilterFont getFont()
public void setFont(TextFilterFont font)
font
- public Boolean getBox()
public void setBox(Boolean box)
box
- If set to true a box is drawn around the text using the background color.public Integer getBoxBorderWidth()
public void setBoxBorderWidth(Integer boxBorderWidth)
boxBorderWidth
- The width of the box drawn around the text.public String getBoxColor()
public void setBoxColor(String boxColor)
boxColor
- The background color to be used for drawing the box.public Integer getLineSpacing()
public void setLineSpacing(Integer lineSpacing)
lineSpacing
- Line spacing of the border around the box in pixelspublic Integer getBorderWidth()
public void setBorderWidth(Integer borderWidth)
borderWidth
- Width of the border around the textpublic Boolean getFixBounds()
public void setFixBounds(Boolean fixBounds)
fixBounds
- If set to true, it will fix text coordinates to avoid clipping if necessarypublic String getFontColor()
public void setFontColor(String fontColor)
fontColor
- The color to be used to draw the textpublic Integer getFontSize()
public void setFontSize(Integer fontSize)
fontSize
- Font size to be used to draw the textpublic String getFontSizeExpression()
public void setFontSizeExpression(String fontSizeExpression)
fontSizeExpression
- An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_widthpublic Double getAlpha()
public void setAlpha(Double alpha)
alpha
- If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.public String getShadowColor()
public void setShadowColor(String shadowColor)
shadowColor
- Color of the shadowpublic Integer getShadowX()
public void setShadowX(Integer shadowX)
shadowX
- X offset of the shadowpublic Integer getShadowY()
public void setShadowY(Integer shadowY)
shadowY
- Y offset of the shadowpublic String getTimecode()
public void setTimecode(String timecode)
timecode
- If set, the timecode representation in \"hh:mm:ss[:;.]ff\" format will be applied. Drop-frame timecodes (containing \";\" or \".\") must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standardpublic String getText()
public void setText(String text)
text
- String to be drawnpublic String getX()
public void setX(String x)
x
- X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)public String getY()
public void setY(String y)
y
- Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width (required)public String getRate()
public void setRate(String rate)
rate
- Video frame rateCopyright © 2022. All rights reserved.