BitmovinApiSdk\Models\TextFilter

Synopsis

class TextFilter extends Filter {
  • // Inherited members from BitmovinResponse
  • public string $id;
  • // Inherited methods from Filter
  • public void __construct()
  • // Inherited methods from BitmovinResponse
  • public void __construct()
  • // Inherited methods from ApiResource
  • public void __construct()
  • public static $this create()
  • public void toArray()
}

Hierarchy

Members

public

  • $alpha — float
  • $borderWidth — int
  • $boxBitmovinApiSdk\Models\bool
  • $boxBorderWidth — int
  • $boxColor — string
  • $createdAtCarbon\Carbon
  • $customData — mixed
  • $description — string
  • $discriminatorMapping
  • $discriminatorName
  • $fixBoundsBitmovinApiSdk\Models\bool
  • $font\BitmovinApiSdk\Models\TextFilterFont
  • $fontColor — string
  • $fontSize — int
  • $fontSizeExpression — string
  • $id — string
  • $lineSpacing — int
  • $modifiedAtCarbon\Carbon
  • $name — string
  • $rate — string
  • $shadowColor — string
  • $shadowX — int
  • $shadowY — int
  • $text — string
  • $timecode — string
  • $x — string
  • $y — string

Methods

public

  • __construct()
  • alpha() — If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.
  • borderWidth() — Width of the border around the text
  • box() — If set to true a box is drawn around the text using the background color.
  • boxBorderWidth() — The width of the box drawn around the text.
  • boxColor() — The background color to be used for drawing the box.
  • fixBounds() — If set to true, it will fix text coordinates to avoid clipping if necessary
  • font() — font
  • fontColor() — The color to be used to draw the text
  • fontSize() — Font size to be used to draw the text
  • 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_width
  • lineSpacing() — Line spacing of the border around the box in pixels
  • rate() — rate
  • shadowColor() — Color of the shadow
  • shadowX() — X offset of the shadow
  • shadowY() — Y offset of the shadow
  • text() — String to be drawn
  • timecode() — If set, the timecode representation in \"hh:mm:ss[:;.]ff\" format will be applied
  • 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)
  • 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)

Inherited from BitmovinApiSdk\Models\BitmovinResource

public

  • customData() — User-specific meta data. This can hold anything.
  • description() — Description of the resource. Can be freely chosen by the user.
  • name() — Name of the resource. Can be freely chosen by the user.

Inherited from BitmovinApiSdk\Common\ApiResource

public