Class TextFilter

Only one of those properties may be set: fontSize, fontSizeExpression.

Inheritance

System.Object

BitmovinResponse

BitmovinResource

Filter

TextFilter

Inherited Members

BitmovinResource.Name

BitmovinResource.Description

BitmovinResource.CreatedAt

BitmovinResource.ModifiedAt

BitmovinResource.CustomData

BitmovinResponse.Id

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Models

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class TextFilter : Filter

Properties

Alpha

If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.

Declaration

public double? Alpha { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

BorderWidth

Width of the border around the text

Declaration

public int? BorderWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Box

If set to true a box is drawn around the text using the background color.

Declaration

public bool? Box { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

BoxBorderWidth

The width of the box drawn around the text.

Declaration

public int? BoxBorderWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

BoxColor

The background color to be used for drawing the box.

Declaration

public string BoxColor { get; set; }

Property Value

Type	Description
System.String

FixBounds

If set to true, it will fix text coordinates to avoid clipping if necessary

Declaration

public bool? FixBounds { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Font

Font

Declaration

public TextFilterFont? Font { get; set; }

Property Value

Type	Description
System.Nullable<TextFilterFont>

FontColor

The color to be used to draw the text

Declaration

public string FontColor { get; set; }

Property Value

Type	Description
System.String

FontSize

Font size to be used to draw the text

Declaration

public int? FontSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

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

Declaration

public string FontSizeExpression { get; set; }

Property Value

Type	Description
System.String

LineSpacing

Line spacing of the border around the box in pixels

Declaration

public int? LineSpacing { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Rate

Rate

Declaration

public string Rate { get; set; }

Property Value

Type	Description
System.String

ShadowColor

Color of the shadow

Declaration

public string ShadowColor { get; set; }

Property Value

Type	Description
System.String

ShadowX

X offset of the shadow

Declaration

public int? ShadowX { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ShadowY

Y offset of the shadow

Declaration

public int? ShadowY { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Text

String to be drawn

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String

Timecode

If set, the timecode representation in "hh:mm:ss[:;.]ff" format will be applied

Declaration

public string Timecode { get; set; }

Property Value

Type	Description
System.String

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)

Declaration

public string X { get; set; }

Property Value

Type	Description
System.String

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)

Declaration

public string Y { get; set; }

Property Value

Type	Description
System.String