![]() |
![]() |
![]() |
GStreamer Base Plugins 0.10 Plugins Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
GstTextOverlay; enum GstTextOverlayVAlign; enum GstTextOverlayHAlign; enum GstTextOverlayWrapMode;
GObject +----GstObject +----GstElement +----GstTextOverlay +----GstTimeOverlay +----GstClockOverlay
"deltax" gint : Read / Write "deltay" gint : Read / Write "font-desc" gchar* : Write "halign" gchar* : Write "shaded-background" gboolean : Read / Write "text" gchar* : Read / Write "valign" gchar* : Write "wrap-mode" GstTextOverlayWrapMode : Read / Write "xpad" gint : Read / Write "ypad" gint : Read / Write "halignment" GstTextOverlayHAlign : Read / Write "valignment" GstTextOverlayVAlign : Read / Write "line-alignment" GstTextOverlayLineAlign : Read / Write "silent" gboolean : Read / Write "wait-text" gboolean : Read / Write "auto-resize" gboolean : Read / Write "vertical-render" gboolean : Read / Write "color" guint : Read / Write "xpos" gdouble : Read / Write "ypos" gdouble : Read / Write
This plugin renders text on top of a video stream. This can be either static text or text from buffers received on the text sink pad, e.g. as produced by the subparse element. If the text sink pad is not linked, the text set via the "text" property will be rendered. If the text sink pad is linked, text will be rendered as it is received on that pad, honouring and matching the buffer timestamps of both input streams.
The text can contain newline characters and text wrapping is enabled by default.
1 |
gst-launch -v videotestsrc ! textoverlay text="Room A" valign=top halign=left ! xvimagesink |
1 |
gst-launch -v filesrc location=subtitles.srt ! subparse ! txt. videotestsrc ! timeoverlay ! textoverlay name=txt shaded-background=yes ! xvimagesink |
If you do not have such a subtitle file, create one looking like this in a text editor:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
1 00:00:03,000 --> 00:00:05,000 Hello? (3-5s) 2 00:00:08,000 --> 00:00:13,000 Yes, this is a subtitle. Don't you like it? (8-13s) 3 00:00:18,826 --> 00:01:02,886 Uh? What are you talking about? I don't understand (18-62s) |
typedef enum { GST_TEXT_OVERLAY_VALIGN_BASELINE, GST_TEXT_OVERLAY_VALIGN_BOTTOM, GST_TEXT_OVERLAY_VALIGN_TOP, GST_TEXT_OVERLAY_VALIGN_POS, GST_TEXT_OVERLAY_VALIGN_CENTER } GstTextOverlayVAlign;
Vertical alignment of the text.
draw text on the baseline | |
draw text on the bottom | |
draw text on top | |
draw text according to the "ypos" property | |
draw text vertically centered |
typedef enum { GST_TEXT_OVERLAY_HALIGN_LEFT, GST_TEXT_OVERLAY_HALIGN_CENTER, GST_TEXT_OVERLAY_HALIGN_RIGHT, GST_TEXT_OVERLAY_HALIGN_UNUSED, GST_TEXT_OVERLAY_HALIGN_POS } GstTextOverlayHAlign;
Horizontal alignment of the text.
align text left | |
align text center | |
align text right | |
position text according to the "xpos" property |
typedef enum { GST_TEXT_OVERLAY_WRAP_MODE_NONE = -1, GST_TEXT_OVERLAY_WRAP_MODE_WORD = PANGO_WRAP_WORD, GST_TEXT_OVERLAY_WRAP_MODE_CHAR = PANGO_WRAP_CHAR, GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR = PANGO_WRAP_WORD_CHAR } GstTextOverlayWrapMode;
Whether to wrap the text and if so how.
"deltax"
property "deltax" gint : Read / Write
Shift X position to the left or to the right. Unit is pixels.
Default value: 0
"deltay"
property "deltay" gint : Read / Write
Shift Y position up or down. Unit is pixels.
Default value: 0
"font-desc"
property "font-desc" gchar* : Write
Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.
Default value: ""
"halign"
property "halign" gchar* : Write
Horizontal alignment of the text (deprecated; use halignment).
Default value: "center"
"shaded-background"
property "shaded-background" gboolean : Read / Write
Whether to shade the background under the text area.
Default value: FALSE
"valign"
property "valign" gchar* : Write
Vertical alignment of the text (deprecated; use valignment).
Default value: "baseline"
"wrap-mode"
property"wrap-mode" GstTextOverlayWrapMode : Read / Write
Whether to wrap the text and if so how.
Default value: wordchar
"xpad"
property "xpad" gint : Read / Write
Horizontal paddding when using left/right alignment.
Allowed values: >= 0
Default value: 25
"ypad"
property "ypad" gint : Read / Write
Vertical padding when using top/bottom alignment.
Allowed values: >= 0
Default value: 25
"halignment"
property"halignment" GstTextOverlayHAlign : Read / Write
Horizontal alignment of the text.
Default value: center
"valignment"
property"valignment" GstTextOverlayVAlign : Read / Write
Vertical alignment of the text.
Default value: baseline
"line-alignment"
property "line-alignment" GstTextOverlayLineAlign : Read / Write
Alignment of text lines relative to each other (for multi-line text)
Default value: center
Since 0.10.15
"silent"
property "silent" gboolean : Read / Write
If set, no text is rendered. Useful to switch off text rendering temporarily without removing the textoverlay element from the pipeline.
Default value: FALSE
Since 0.10.15
"wait-text"
property "wait-text" gboolean : Read / Write
If set, the video will block until a subtitle is received on the text pad. If video and subtitles are sent in sync, like from the same demuxer, this property should be set.
Default value: TRUE
Since 0.10.20
"auto-resize"
property "auto-resize" gboolean : Read / Write
Automatically adjust font size to screen-size.
Default value: TRUE
"vertical-render"
property "vertical-render" gboolean : Read / Write
Vertical Render.
Default value: FALSE
"color"
property "color" guint : Read / Write
Color of the rendered text.
Default value: 4294967295
Since 0.10.31
"xpos"
property "xpos" gdouble : Read / Write
Horizontal position of the rendered text when using positioned alignment.
Allowed values: [0,1]
Default value: 0.5
Since 0.10.31