# dwritesubtitleoverlay

Adds subtitle strings on top of a video buffer

## Hierarchy

    GObject
        ╰──GInitiallyUnowned
            ╰──GstObject
                ╰──GstElement
                    ╰──GstBin
                        ╰──dwritesubtitleoverlay

## Implemented interfaces

    GstChildProxy

## Factory details

Authors: – Seungha Yang <seungha></seungha>

Classification: – `Filter/Editor/Video/Overlay/Subtitle`

Rank – none

Plugin – dwrite

Package – GStreamer Bad Plug-ins

## Pad Templates

### `src`

    video/x-raw(ANY):

Presence – always

Direction – src

Object type – GstPad

### `text`

    text/x-raw:
             format: { pango-markup, utf8 }

Presence – always

Direction – sink

Object type – GstPad

### `video`

    video/x-raw(ANY):

Presence – always

Direction – sink

Object type – GstPad

## Properties

### auto-resize

    “auto-resize” gboolean

Calculate font size to be equivalent to "font-size" at "reference-frame-size"

Flags : Read / Write

Default value : true

### background-color

    “background-color” guint

Background color to use (big-endian ARGB)

Flags : Read / Write

Default value : 0

### cc-field

    “cc-field” gint

The closed caption field to render when available, (-1 = automatic)

Flags : Read / Write

Default value : -1

### cc-timeout

    “cc-timeout” guint64

Duration after which to erase overlay when no cc data has arrived for the selected field, in nanoseconds unit

Flags : Read / Write

Default value : 18446744073709551615

### color-font

    “color-font” gboolean

Enable color font, requires Windows 10 or newer

Flags : Read / Write

Default value : true

### enable-cc

    “enable-cc” gboolean

Enable closed caption rendering

Flags : Read / Write

Default value : true

### font-family

    “font-family” gchararray

Font family to use

Flags : Read / Write

Default value : MS Reference Sans Serif

### font-size

    “font-size” gfloat

Font size to use

Flags : Read / Write

Default value : 20

### font-stretch

    “font-stretch” GstDWriteFontStretch *

Font Stretch

Flags : Read / Write

Default value : normal (5)

### font-style

    “font-style” GstDWriteFontStyle *

Font Style

Flags : Read / Write

Default value : normal (0)

### font-weight

    “font-weight” GstDWriteFontWeight *

Font Weight

Flags : Read / Write

Default value : normal (400)

### foreground-color

    “foreground-color” guint

Foreground color to use (big-endian ARGB)

Flags : Read / Write

Default value : -1

### layout-height

    “layout-height” gdouble

Normalized height of text layout

Flags : Read / Write

Default value : 0.92

### layout-width

    “layout-width” gdouble

Normalized width of text layout

Flags : Read / Write

Default value : 0.92

### layout-x

    “layout-x” gdouble

Normalized X coordinate of text layout

Flags : Read / Write

Default value : 0.03

### layout-y

    “layout-y” gdouble

Normalized Y coordinate of text layout

Flags : Read / Write

Default value : 0.03

### outline-color

    “outline-color” guint

Text outline color to use (big-endian ARGB)

Flags : Read / Write

Default value : -16777216

### paragraph-alignment

    “paragraph-alignment” GstDWriteParagraphAlignment *

Paragraph Alignment

Flags : Read / Write

Default value : far (1)

### remove-cc-meta

    “remove-cc-meta” gboolean

Remove caption meta from output buffers when closed caption rendering is enabled

Flags : Read / Write

Default value : false

### shadow-color

    “shadow-color” guint

Shadow color to use (big-endian ARGB)

Flags : Read / Write

Default value : -2147483648

### text

    “text” gchararray

Text to render

Flags : Read / Write

### text-alignment

    “text-alignment” GstDWriteTextAlignment *

Text Alignment

Flags : Read / Write

Default value : center (2)

### visible

    “visible” gboolean

Whether to draw text

Flags : Read / Write

Default value : true

The results of the search are