GstBase::TextOverlay Class Reference
[gstreamerbasemm Plugins]

GstBase::TextOverlay — textoverlay plugin. More...

#include <textoverlay.h>

Inheritance diagram for GstBase::TextOverlay:

Gst::Element Gst::Object GstBase::ClockOverlay GstBase::TimeOverlay

List of all members.

Public Member Functions

virtual ~TextOverlay ()
GstTextOverlay* gobj ()
 Provides access to the underlying C GObject.
const GstTextOverlay* gobj () const
 Provides access to the underlying C GObject.
GstTextOverlay* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy
<Glib::ustring> 
property_text ()
 Text to be display.
Glib::PropertyProxy_ReadOnly
<Glib::ustring> 
property_text () const
 Text to be display.
Glib::PropertyProxy<bool> property_shaded_background ()
 Whether to shade the background under the text area.
Glib::PropertyProxy_ReadOnly
<bool> 
property_shaded_background () const
 Whether to shade the background under the text area.
Glib::PropertyProxy_WriteOnly
<Glib::ustring> 
property_valign ()
 Vertical alignment of the text (deprecated; use valignment).
Glib::PropertyProxy_WriteOnly
<Glib::ustring> 
property_halign ()
 Horizontal alignment of the text (deprecated; use halignment).
Glib::PropertyProxy
<TextOverlayHAlign
property_halignment ()
 Horizontal alignment of the text.
Glib::PropertyProxy_ReadOnly
<TextOverlayHAlign
property_halignment () const
 Horizontal alignment of the text.
Glib::PropertyProxy
<TextOverlayVAlign
property_valignment ()
 Vertical alignment of the text.
Glib::PropertyProxy_ReadOnly
<TextOverlayVAlign
property_valignment () const
 Vertical alignment of the text.
Glib::PropertyProxy<int> property_xpad ()
 Horizontal paddding when using left/right alignment.
Glib::PropertyProxy_ReadOnly<int> property_xpad () const
 Horizontal paddding when using left/right alignment.
Glib::PropertyProxy<int> property_ypad ()
 Vertical padding when using top/bottom alignment.
Glib::PropertyProxy_ReadOnly<int> property_ypad () const
 Vertical padding when using top/bottom alignment.
Glib::PropertyProxy<int> property_deltax ()
 Shift X position to the left or to the right.
Glib::PropertyProxy_ReadOnly<int> property_deltax () const
 Shift X position to the left or to the right.
Glib::PropertyProxy<int> property_deltay ()
 Shift Y position up or down.
Glib::PropertyProxy_ReadOnly<int> property_deltay () const
 Shift Y position up or down.
Glib::PropertyProxy
<TextOverlayWrapMode
property_wrap_mode ()
 Whether to wrap the text and if so how.
Glib::PropertyProxy_ReadOnly
<TextOverlayWrapMode
property_wrap_mode () const
 Whether to wrap the text and if so how.
Glib::PropertyProxy_WriteOnly
<Glib::ustring> 
property_font_desc ()
 Pango font description of font to be used for rendering.
Glib::PropertyProxy<bool> property_silent ()
 Whether to render the text string.
Glib::PropertyProxy_ReadOnly
<bool> 
property_silent () const
 Whether to render the text string.
Glib::PropertyProxy
<TextOverlayLineAlign
property_line_alignment ()
 Alignment of text lines relative to each other.
Glib::PropertyProxy_ReadOnly
<TextOverlayLineAlign
property_line_alignment () const
 Alignment of text lines relative to each other.
Glib::PropertyProxy<bool> property_wait_text ()
 Whether to wait for subtitles.
Glib::PropertyProxy_ReadOnly
<bool> 
property_wait_text () const
 Whether to wait for subtitles.

Static Public Member Functions

static Glib::RefPtr<TextOverlaycreate ()
 Creates a new textoverlay plugin with a unique name.
static Glib::RefPtr<TextOverlaycreate (const Glib::ustring& name)
 Creates a new textoverlay plugin with the given name.

Protected Member Functions

 TextOverlay ()
 TextOverlay (const Glib::ustring& name)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
<GstBase::TextOverlay
wrap (GstTextOverlay* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Detailed Description

GstBase::TextOverlay — textoverlay plugin.

Please include <gstreamerbasemm/textoverlay.h> to use. Also, though using the underlying GObject is fine, using its C type is not guaranteed to be API stable across releases because it is not guaranteed to always remain the same.


Constructor& Destructor Documentation

virtual GstBase::TextOverlay::~TextOverlay (  )  [virtual]

GstBase::TextOverlay::TextOverlay (  )  [protected]

GstBase::TextOverlay::TextOverlay ( const Glib::ustring &  name  )  [protected]


Member Function Documentation

static Glib::RefPtr<TextOverlay> GstBase::TextOverlay::create ( const Glib::ustring &  name  )  [static]

Creates a new textoverlay plugin with the given name.

Reimplemented in GstBase::ClockOverlay, and GstBase::TimeOverlay.

static Glib::RefPtr<TextOverlay> GstBase::TextOverlay::create (  )  [static]

Creates a new textoverlay plugin with a unique name.

Reimplemented in GstBase::ClockOverlay, and GstBase::TimeOverlay.

const GstTextOverlay* GstBase::TextOverlay::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

Reimplemented in GstBase::ClockOverlay, and GstBase::TimeOverlay.

GstTextOverlay* GstBase::TextOverlay::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

Reimplemented in GstBase::ClockOverlay, and GstBase::TimeOverlay.

GstTextOverlay* GstBase::TextOverlay::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Gst::Element.

Reimplemented in GstBase::ClockOverlay, and GstBase::TimeOverlay.

Glib::PropertyProxy_ReadOnly<int> GstBase::TextOverlay::property_deltax (  )  const

Shift X position to the left or to the right.

Unit is pixels.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> GstBase::TextOverlay::property_deltax (  ) 

Shift X position to the left or to the right.

Unit is pixels.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> GstBase::TextOverlay::property_deltay (  )  const

Shift Y position up or down.

Unit is pixels.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> GstBase::TextOverlay::property_deltay (  ) 

Shift Y position up or down.

Unit is pixels.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_WriteOnly<Glib::ustring> GstBase::TextOverlay::property_font_desc (  ) 

Pango font description of font to be used for rendering.

See documentation of pango_font_description_from_string for syntax.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_WriteOnly<Glib::ustring> GstBase::TextOverlay::property_halign (  ) 

Horizontal alignment of the text (deprecated; use halignment).

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<TextOverlayHAlign> GstBase::TextOverlay::property_halignment (  )  const

Horizontal alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<TextOverlayHAlign> GstBase::TextOverlay::property_halignment (  ) 

Horizontal alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<TextOverlayLineAlign> GstBase::TextOverlay::property_line_alignment (  )  const

Alignment of text lines relative to each other.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<TextOverlayLineAlign> GstBase::TextOverlay::property_line_alignment (  ) 

Alignment of text lines relative to each other.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> GstBase::TextOverlay::property_shaded_background (  )  const

Whether to shade the background under the text area.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> GstBase::TextOverlay::property_shaded_background (  ) 

Whether to shade the background under the text area.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> GstBase::TextOverlay::property_silent (  )  const

Whether to render the text string.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> GstBase::TextOverlay::property_silent (  ) 

Whether to render the text string.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> GstBase::TextOverlay::property_text (  )  const

Text to be display.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> GstBase::TextOverlay::property_text (  ) 

Text to be display.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_WriteOnly<Glib::ustring> GstBase::TextOverlay::property_valign (  ) 

Vertical alignment of the text (deprecated; use valignment).

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<TextOverlayVAlign> GstBase::TextOverlay::property_valignment (  )  const

Vertical alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<TextOverlayVAlign> GstBase::TextOverlay::property_valignment (  ) 

Vertical alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> GstBase::TextOverlay::property_wait_text (  )  const

Whether to wait for subtitles.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> GstBase::TextOverlay::property_wait_text (  ) 

Whether to wait for subtitles.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<TextOverlayWrapMode> GstBase::TextOverlay::property_wrap_mode (  )  const

Whether to wrap the text and if so how.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<TextOverlayWrapMode> GstBase::TextOverlay::property_wrap_mode (  ) 

Whether to wrap the text and if so how.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> GstBase::TextOverlay::property_xpad (  )  const

Horizontal paddding when using left/right alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> GstBase::TextOverlay::property_xpad (  ) 

Horizontal paddding when using left/right alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> GstBase::TextOverlay::property_ypad (  )  const

Vertical padding when using top/bottom alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> GstBase::TextOverlay::property_ypad (  ) 

Vertical padding when using top/bottom alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.


Friends And Related Function Documentation

Glib::RefPtr<GstBase::TextOverlay> wrap ( GstTextOverlay *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated on Thu Jan 15 09:33:14 2009 for gstreamermm by  doxygen 1.5.7.1