Text Overlay

Factory Details:

Rankprimary + 10 (266)
Long-nameST Text overlay
KlassFilter/Video/Overlay/Subtitle
DescriptionConvert text to ARGB32 format to display on ST GDP layer
Authorwww.st.com

Plugin Details:

Namest
DescriptionST HW accelerated elements
Filename/usr/lib/gstreamer-1.0/libgstpluginst.so
Version1.0.0
LicenseLGPL
Source modulestplugin
Binary packageSTMicroelectronics R&D
Origin URLhttp://www.st.com

Hierarchy:

  • GObject
    • GInitiallyUnowned
      • GstObject
        • GstElement
          • GstSTTextOverlay

Pad Templates:

SRC template: src

  • Availability: Always
  • Capabilities:
    • video/x-raw
      • format: RGBA
      • width: [ 1, 2147483647 ]
      • height: [ 1, 2147483647 ]
      • framerate: [ 0/1, 2147483647/1 ]

SINK template: video_sink

  • Availability: Always
  • Capabilities:
    • video/x-fake-yuv

SINK template: text_sink

  • Availability: Always
  • Capabilities:
    • text/x-raw
      • format: { pango-markup, utf8 }
    • text/plain
    • subpicture/x-dvb
    • private/teletext
    • private/closecaption
    • ancillary/none

Element Flags:

no flags set

Element Implementation:

  • change_state()  gst_sttext_overlay_change_state()

Element has no clocking capabilities.

Element has no URI handling capabilities.

Pads:

  • SINK (video_sink)
    • Pad Template: video_sink
  • SINK (text_sink)
    • Pad Template: text_sink
  • SRC (src)
    • Pad Template: src

Element Properties:

The "name" Property

The name of the object

  • Flags:
    • Readable
    • Writable
  • Type: String
    • Default: "sttextoverlay0"

The "parent" Property

The parent of the object

  • Flags:
    • Readable
    • Writable
  • Type: Object
    • Type: GstObject

The "text" Property

Text to be display.

  • Flags:
    • Readable
    • Writable
    • Controllable
  • Type: String
    • Default: ""

The "shaded-background" Property

Whether to shade the background under the text area

  • Flags:
    • Readable
    • Writable
  • Type: Boolean
    • Default: false

The "valign" Property

Vertical alignment of the ext (deprecated; use valignment)

  • Flags:
    • Writable
  • Type: String
    • Default: "baseline"

The "halign" Property

Horizontal alignment of the text (deprecated; use halignment)

  • Flags:
    • Writable
  • Type: String
    • Default: "center"

The "halignment" Property

Horizontal alignment of the text

  • Flags:
    • Readable
    • Writable
  • Type: enum GstSTTextOverlayHAlign
    • Default: 1 (center)
    • Values:
      1. left
      2. center
      3. right
      4. position

The "valignment" Property

Vertical alignment of the text

  • Flags:
    • Readable
    • Writable
  • Type: enum GstSTTextOverlayVAlign
    • Default: 0 (baseline)
    • Values:
      1. baseline
      2. bottom
      3. top
      4. position

The "xpad" Property

Horizontal paddding when using left/right alignment

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: 0
    • Max: 2147483647
    • Default: 25

The "ypad" Property

Vertical padding when using top/bottom alignment

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: 0
    • Max: 2147483647
    • Default: 25

The "deltax" Property

Shift X position to the left or to the right. Unit is pixels.

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: -2147483648
    • Max: 2147483647
    • Default: 0

The "deltay" Property

Shift Y position up or down. Unit is pixels.

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: -2147483648
    • Max: 2147483647
    • Default: 0

The "xpos" Property

Horizontal position when using position alignment

  • Flags:
    • Readable
    • Writable
    • Controllable
  • Type: Double
    • Min: 0
    • Max: 1
    • Default: 0.5

The "ypos" Property

Vertical position when using position alignment

  • Flags:
    • Readable
    • Writable
    • Controllable
  • Type: Double
    • Min: 0
    • Max: 1
    • Default: 0.5

The "wrap-mode" Property

Whether to wrap the text and if so how.

  • Flags:
    • Readable
    • Writable
  • Type: enum GstSTTextOverlayWrapMode
    • Default: 2 (wordchar)
    • Values:
      1. none
      2. word
      3. char
      4. wordchar

The "font-desc" Property

Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.

  • Flags:
    • Writable
  • Type: String
    • Default: ""

The "silent" Property

Whether to render the text string

  • Flags:
    • Readable
    • Writable
    • Controllable
  • Type: Boolean
    • Default: false

The "line-alignment" Property

Alignment of text lines relative to each other.

  • Flags:
    • Readable
    • Writable
  • Type: enum GstSTTextOverlayLineAlign
    • Default: 1 (center)
    • Values:
      1. left
      2. center
      3. right

The "wait-text" Property

Whether to wait for subtitles

  • Flags:
    • Readable
    • Writable
  • Type: Boolean
    • Default: true

The "auto-resize" Property

Automatically adjust font size to screen-size.

  • Flags:
    • Readable
    • Writable
  • Type: Boolean
    • Default: true

The "vertical-render" Property

Vertical Render.

  • Flags:
    • Readable
    • Writable
  • Type: Boolean
    • Default: false

The "color" Property

Color to use for text (big-endian ARGB).

  • Flags:
    • Readable
    • Writable
    • Controllable
  • Type: Unsigned Integer
    • Min: 0
    • Max: 4294967295
    • Default: 4294967295

The "teletext-page" Property

Teletext page number that should displayed

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: 100
    • Max: 999
    • Default: 0

The "teletext-subpage" Property

Teletext sub-page number that should displayed (-1 for all)

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: -1
    • Max: 153
    • Default: 0

The "subtitles-mode" Property

Enables subtitles mode for text output stripping the blank lines and the teletext state lines

  • Flags:
    • Readable
    • Writable
  • Type: Boolean
    • Default: false

The "subtitles-template" Property

Output template used to print each one of the subtitles lines

  • Flags:
    • Readable
    • Writable
  • Type: String
    • Default: null

The "font-description" Property

Font description used for the pango output.

  • Flags:
    • Readable
    • Writable
  • Type: String
    • Default: null

The "cc-user-cmd" Property

Number of closed captions that should displayed (-1 for all)

  • Flags:
    • Readable
    • Writable
  • Type: Integer
    • Min: -1
    • Max: 153
    • Default: 0