VideoDrawtext (Jave core package 2.7.3 API)

java.lang.Object
- ws.schild.jave.VideoFilter
- - ws.schild.jave.filters.VideoDrawtext

```
public class VideoDrawtext
extends VideoFilter
```
Add a text watermark in the video file https://write.corbpie.com/how-to-do-a-text-watermark-in-ffmpeg/ -vf "drawtext=text='a watermark':x=10:y=H-th-10:fontfile=/pathto/font.ttf:fontsize=10:fontcolor=white:shadowcolor=black:shadowx=2:shadowy=2"

Author:

andre

Constructor Summary

Constructors
Constructor and Description
`VideoDrawtext(String watermarkText, Color fontColor)`
`VideoDrawtext(String watermarkText, int posX, int posY, String fontName, File fontFile, float fontSize, Color fontColor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAddArgument()`
`Color`	`getBorderColor()`
`int`	`getBorderWidth()`
`int`	`getBoxBorderWidth()`
`Color`	`getBoxColor()`
`String`	`getExpression()`
`Color`	`getFontColor()`
`File`	`getFontFile()`
`String`	`getFontName()`
`float`	`getFontSize()`
`int`	`getLineSpacing()`
`int`	`getPosX()`
`int`	`getPosY()` ignored if posX & posY are both -1
`Color`	`getShadowColor()`
`int`	`getShadowX()`
`int`	`getShadowY()`
`String`	`getWatermarkText()`
`VideoDrawtext`	`setAddArgument(String addArgument)` Add an additional argument to the command line https://superuser.com/questions/939357/position-text-on-bottom-right-corner Bottom right x=w-tw:y=h-th Bottom right with 10 pixel padding x=w-tw-10:y=h-th-10 Top right x=w-tw Top right with 10 pixel padding x=w-tw-10:y=10 Top left x=0:y=0 Top left with 10 pixel padding x=10:y=10 Bottom left y=h-th Bottom left with 10 pixel padding x=10:h-th-10 centered x=(w-text_w)/2:y=(h-text_h)/2 Can be used to speicfy other positions like "x=(w-text_w)/2:y=(h-text_h)/2" for centered text water mark
`VideoDrawtext`	`setBorderColor(Color borderColor)`
`VideoDrawtext`	`setBorderWidth(int borderWidth)`
`VideoDrawtext`	`setBox(int borderWidth, Color color)`
`VideoDrawtext`	`setBoxBorderWidth(int boxBorderWidth)`
`VideoDrawtext`	`setBoxColor(Color boxColor)`
`VideoDrawtext`	`setFontColor(Color fontColor)`
`VideoDrawtext`	`setFontFile(File fontFile)`
`VideoDrawtext`	`setFontName(String fontName)`
`VideoDrawtext`	`setFontSize(float fontSize)`
`VideoDrawtext`	`setLineSpacing(int lineSpacing)`
`VideoDrawtext`	`setPosX(int posX)` ignored if posX & posY are both -1
`VideoDrawtext`	`setPosY(int posY)`
`VideoDrawtext`	`setShadow(Color shadowColor, int shadowX, int shadowY)`
`VideoDrawtext`	`setShadowColor(Color shadowColor)`
`VideoDrawtext`	`setShadowX(int shadowX)`
`VideoDrawtext`	`setShadowY(int shadowY)`
`VideoDrawtext`	`setWatermarkText(String watermarkText)`

Methods inherited from class ws.schild.jave.VideoFilter
setExpression, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VideoDrawtext
```
public VideoDrawtext(String watermarkText,
                     Color fontColor)
              throws IllegalArgumentException
```
    Parameters:
    
    watermarkText - Text to be used as watermark
    
    fontColor - Color of font
    
    Throws:
    
    IllegalArgumentException
  - VideoDrawtext
```
public VideoDrawtext(String watermarkText,
                     int posX,
                     int posY,
                     String fontName,
                     File fontFile,
                     float fontSize,
                     Color fontColor)
              throws IllegalArgumentException
```
    Parameters:
    
    watermarkText - Text to be used as watermark
    
    posX - X Position of watermark text (From the left) ignored if posX & posY are both -1
    
    posY - Y Position of watermark text (From the top) ignored if posX & posY are both -1
    
    fontName - Use this font (Can be null, but then we need a fontFile)
    
    fontFile - Truetype font file (Only required when fontName is NULL)
    
    fontSize - Font size
    
    fontColor - Color of font
    
    Throws:
    
    IllegalArgumentException
- Method Detail
  - setShadow
```
public VideoDrawtext setShadow(Color shadowColor,
                               int shadowX,
                               int shadowY)
```
    Parameters:
    
    shadowColor - Color of shadow
    
    shadowX - X Position of shadow, relative to text
    
    shadowY - Y Position of shadow, relative to text
    
    Returns:
    
    this instance
  - getWatermarkText
```
public String getWatermarkText()
```
    Returns:
    
    the watermarkText
  - setWatermarkText
```
public VideoDrawtext setWatermarkText(String watermarkText)
```
    Parameters:
    
    watermarkText - the watermarkText to set
    
    Returns:
    
    this instance
  - getPosX
```
public int getPosX()
```
    Returns:
    
    the posX
  - setPosX
```
public VideoDrawtext setPosX(int posX)
```
    ignored if posX & posY are both -1
    
    Parameters:
    
    posX - the posX to set
    
    Returns:
    
    this instance
  - getPosY
```
public int getPosY()
```
    ignored if posX & posY are both -1
    
    Returns:
    
    the posY
  - setPosY
```
public VideoDrawtext setPosY(int posY)
```
    Parameters:
    
    posY - the posY to set
    
    Returns:
    
    this instance
  - getFontName
```
public String getFontName()
```
    Returns:
    
    the fontName
  - setFontName
```
public VideoDrawtext setFontName(String fontName)
```
    Parameters:
    
    fontName - the fontName to set
    
    Returns:
    
    this instance
  - getFontFile
```
public File getFontFile()
```
    Returns:
    
    the fontFile
  - setFontFile
```
public VideoDrawtext setFontFile(File fontFile)
```
    Parameters:
    
    fontFile - the fontFile to set
    
    Returns:
    
    this instance
  - getFontSize
```
public float getFontSize()
```
    Returns:
    
    the fontSize
  - setFontSize
```
public VideoDrawtext setFontSize(float fontSize)
```
    Parameters:
    
    fontSize - the fontSize to set
    
    Returns:
    
    this instance
  - getFontColor
```
public Color getFontColor()
```
    Returns:
    
    the fontColor
  - setFontColor
```
public VideoDrawtext setFontColor(Color fontColor)
```
    Parameters:
    
    fontColor - the fontColor to set
    
    Returns:
    
    this instance
  - getShadowColor
```
public Color getShadowColor()
```
    Returns:
    
    the shadowColor
  - setShadowColor
```
public VideoDrawtext setShadowColor(Color shadowColor)
```
    Parameters:
    
    shadowColor - the shadowColor to set
    
    Returns:
    
    this instance
  - getShadowX
```
public int getShadowX()
```
    Returns:
    
    the shadowX
  - setShadowX
```
public VideoDrawtext setShadowX(int shadowX)
```
    Parameters:
    
    shadowX - the shadowX to set
    
    Returns:
    
    this instance
  - getShadowY
```
public int getShadowY()
```
    Returns:
    
    the shadowY
  - setShadowY
```
public VideoDrawtext setShadowY(int shadowY)
```
    Parameters:
    
    shadowY - the shadowY to set
    
    Returns:
    
    this instance
  - setBox
```
public VideoDrawtext setBox(int borderWidth,
                            Color color)
```
  - getBoxBorderWidth
```
public int getBoxBorderWidth()
```
    Returns:
    
    the boxBorderWidth
  - setBoxBorderWidth
```
public VideoDrawtext setBoxBorderWidth(int boxBorderWidth)
```
    Parameters:
    
    boxBorderWidth - the boxBorderWidth to set
    
    Returns:
    
    this instance
  - getBoxColor
```
public Color getBoxColor()
```
    Returns:
    
    the boxColor
  - setBoxColor
```
public VideoDrawtext setBoxColor(Color boxColor)
```
    Parameters:
    
    boxColor - the boxColor to set
    
    Returns:
    
    this instance
  - getBorderWidth
```
public int getBorderWidth()
```
    Returns:
    
    the borderWidth
  - setBorderWidth
```
public VideoDrawtext setBorderWidth(int borderWidth)
```
    Parameters:
    
    borderWidth - the borderWidth to set
    
    Returns:
    
    this instance
  - getBorderColor
```
public Color getBorderColor()
```
    Returns:
    
    the borderColor
  - setBorderColor
```
public VideoDrawtext setBorderColor(Color borderColor)
```
    Parameters:
    
    borderColor - the borderColor to set
    
    Returns:
    
    this instance
  - getLineSpacing
```
public int getLineSpacing()
```
    Returns:
    
    the lineSpacing
  - setLineSpacing
```
public VideoDrawtext setLineSpacing(int lineSpacing)
```
    Parameters:
    
    lineSpacing - the lineSpacing to set
    
    Returns:
    
    this instance
  - getAddArgument
```
public String getAddArgument()
```
    Returns:
    
    the addArgument
  - setAddArgument
```
public VideoDrawtext setAddArgument(String addArgument)
```
    Add an additional argument to the command line https://superuser.com/questions/939357/position-text-on-bottom-right-corner Bottom right x=w-tw:y=h-th Bottom right with 10 pixel padding x=w-tw-10:y=h-th-10 Top right x=w-tw Top right with 10 pixel padding x=w-tw-10:y=10 Top left x=0:y=0 Top left with 10 pixel padding x=10:y=10 Bottom left y=h-th Bottom left with 10 pixel padding x=10:h-th-10 centered x=(w-text_w)/2:y=(h-text_h)/2 Can be used to speicfy other positions like "x=(w-text_w)/2:y=(h-text_h)/2" for centered text water mark
    
    Parameters:
    
    addArgument - the addArgument to set
    
    Returns:
    
    this instance
  - getExpression
```
public String getExpression()
```
    Overrides:
    
    getExpression in class VideoFilter

Class VideoDrawtext

Constructor Summary

Method Summary

Methods inherited from class ws.schild.jave.VideoFilter

Methods inherited from class java.lang.Object

Constructor Detail

VideoDrawtext

VideoDrawtext

Method Detail

setShadow

getWatermarkText

setWatermarkText

getPosX

setPosX

getPosY

setPosY

getFontName

setFontName

getFontFile

setFontFile

getFontSize

setFontSize

getFontColor

setFontColor

getShadowColor

setShadowColor

getShadowX

setShadowX

getShadowY

setShadowY

setBox

getBoxBorderWidth

setBoxBorderWidth

getBoxColor

setBoxColor

getBorderWidth

setBorderWidth

getBorderColor

setBorderColor

getLineSpacing

setLineSpacing

getAddArgument

setAddArgument

getExpression