Simple Text

The textsimple Image Provider renders a text.

Field name	Type	Description
Required fields
type	ImageProvider.Type	textsimple
text	StringVariable	Text to be rendered
color	Color	Text color
fontsize_d	double	Size of the font
Optional fields
source	FileLocation	Location of the font file. If omitted a sans-serif font will be used
width	int	The width of the rendered text. If not specified the width will be inferred from the visual track below or from the movie if there is no other visual track.
height	int	The height of the rendered text. If not specified the width will be inferred from the visual track below or from the movie if there is no other visual track.
center	boolean	Center text
xalignment	TextAlignment	Horizontal text alignment
yalignment	TextPosition	Vertical text position
fontspacing	double	extra character spacing
linespacing	double	extra line spacing
textoverflowbehaviour	TextOverflowBehaviour	Specify how to handle text too large to fit in width X height
texttexture	ImageProvider	Fill glyphs with texture
textoutlines	TextOutline []	Draws outlines around each glyph
textoutlinesubpixellevel	double	Subsampling precision of outline rendering (Default: 1.0)
textaugmentations	TextAugment []	Add extra stuff to the text
textborder_top	int	Add extra space around text
textborder_right	int	Add extra space around text
textborder_bottom	int	Add extra space around text
textborder_left	int	Add extra space around text
Optional formatting
textcontexts	TextContext []	Array of TextContexts used in the text markup
usetextcontextmarkup	boolean	Enable markup in text using TextContexts
Optional animation fields
texttypewritereffect	Function	Animate characters over time
texttypewriterfadestart	Function	First character to animate opacity of typewriter effect
texttypewriterfadeend	Function	Last character to animate opacity of typewriter effect
fontspacing_function	Function	Animate character spacing text block
linespacing_function	Function	Animate line spacing text block

TextContext

Field name	Type	Description
Required fields
name	string	Name for context
Optional fields
fontsize	double	Font size in pixel
fontspacing	double	Letterspacing
color	Color	Text color
font	FileLocation	Location of the font file. If omitted a sans-serif font will be used
texture	ImageProvider	Fill border with texture

TextAlignment

Enum	Description
flushleft
centered
flushright

TextPosition

Enum	Description
top
middle
bottom

TextOverflowBehaviour

Enum	Description
textoverflowbehaviour_none	Do nothing, overflowing text will be cut off
textoverflowbehaviour_scale_x	If text overflows in X-axis, condense it, so it will fit. Y-axis overflow will be cut off
textoverflowbehaviour_fs_y_scale_x	First decrease fontsize, so text will fit in Y-axis, then condense text, so that it fits in X-axis
textoverflowbehaviour_fs	Decrease fontsize, so that text fits

TextOutline

Field name	Type	Description
Required fields
type	TextOutline.Type	rounded | simple
Optional fields
color	Color	Text color
texture	ImageProvider	Fill border with texture
size	double	Border size in pixels

TextAugment

Field name	Type	Description
Required fields
content	ImageProvider	Place this image provider next to character
Optional fields
anchor_character	double	Position of image provider(in percent of string, rounded)
x	double	offset in pixels (rounded)
y	double	offset in pixels (rounded)
size	double	in percent of line height

Example

{
    "scenes": [
        {
            "numframes": 200,
            "tracks": [
                {
                    "content": {
                        "type": "textsimple",
                        "text": {
                            "type": "constant",
                            "value": "Hello World"
                        },
                        "fontsize": 24,
                        "color": {
                            "red": 200,
                            "green": 68,
                            "blue": 12,
                            "alpha": 255
                        },
                        "width": 640,
                        "height": 360
                    }
                }
            ]
        }
    ],
    "params": {
        "vparams": {
            "width": 640,
            "height": 360
        }
    }
}