BitmovinApiSdk\Models\TextFilter
Synopsis
class TextFilter
extends Filter
{
- // members
- public TextFilterFont $font;
- public bool $box;
- public int $boxBorderWidth;
- public string $boxColor;
- public int $lineSpacing;
- public int $borderWidth;
- public bool $fixBounds;
- public string $fontColor;
- public int $fontSize;
- public string $fontSizeExpression;
- public float $alpha;
- public string $shadowColor;
- public int $shadowX;
- public int $shadowY;
- public string $timecode;
- public string $text;
- public string $x;
- public string $y;
- public string $rate;
- // Inherited members from Filter
- public static string $discriminatorName;
- public static array $discriminatorMapping;
- // Inherited members from BitmovinResource
- public string $name;
- public string $description;
- public Carbon $createdAt;
- public Carbon $modifiedAt;
- public mixed $customData;
- // Inherited members from BitmovinResponse
- public string $id;
- // methods
- public void __construct()
- public $this font()
- public $this box()
- public $this boxBorderWidth()
- public $this boxColor()
- public $this lineSpacing()
- public $this borderWidth()
- public $this fixBounds()
- public $this fontColor()
- public $this fontSize()
- public $this fontSizeExpression()
- public $this alpha()
- public $this shadowColor()
- public $this shadowX()
- public $this shadowY()
- public $this timecode()
- public $this text()
- public $this x()
- public $this y()
- public $this rate()
- // Inherited methods from Filter
- public void __construct()
- // Inherited methods from BitmovinResource
- public void __construct()
- public $this name()
- public $this description()
- public $this customData()
- // Inherited methods from BitmovinResponse
- public void __construct()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Extends
Members
public
- $alpha — float
- $borderWidth — int
- $box — BitmovinApiSdk\Models\bool
- $boxBorderWidth — int
- $boxColor — string
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $discriminatorMapping
- $discriminatorName
- $fixBounds — BitmovinApiSdk\Models\bool
- $font — BitmovinApiSdk\Models\TextFilterFont
- $fontColor — string
- $fontSize — int
- $fontSizeExpression — string
- $id — string
- $lineSpacing — int
- $modifiedAt — Carbon\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() — Video frame 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. 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 standard
- 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.