Create Text Filter

post

https://api.bitmovin.com/v1/encoding/filters/text

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The Text Filter to be created

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

name

string

Name of the resource. Can be freely chosen by the user.

description

string

Description of the resource. Can be freely chosen by the user.

customData

string

User-specific meta data. This can hold anything.

font

string

enum

Defaults to DEJAVUSANS

Allowed:

box

boolean

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

boxBorderWidth

integer

The width of the box drawn around the text.

boxColor

string

The background color to be used for drawing the box.

lineSpacing

integer

Line spacing of the border around the box in pixels

borderWidth

integer

Width of the border around the text

fixBounds

boolean

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

fontColor

string

The color to be used to draw the text

fontSize

integer

Font size to be used to draw the text

fontSizeExpression

string

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

alpha

double

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

shadowColor

string

Color of the shadow

shadowX

integer

X offset of the shadow

shadowY

integer

Y offset of the shadow

timecode

string

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

text

string

String to be drawn

string

required

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

string

required

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

rate

string

Video frame rate

Responses

201Successful response.

defaultError response.