Gst::VorbisEnc Class Reference
[gstreamermm Plugins]

A Wrapper for the vorbisenc plugin. More...

Inherits Gst::Element, Gst::TagSetter, and Gst::Preset.

Collaboration diagram for Gst::VorbisEnc:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~VorbisEnc ()
GstVorbisEnc* gobj ()
 Provides access to the underlying C GObject.
const GstVorbisEnc* gobj () const
 Provides access to the underlying C GObject.
GstVorbisEnc* 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< int > property_max_bitrate ()
 Specify a maximum bitrate (in bps).
Glib::PropertyProxy_ReadOnly< int > property_max_bitrate () const
 Specify a maximum bitrate (in bps).
Glib::PropertyProxy< int > property_bitrate ()
 Attempt to encode at a bitrate averaging this (in bps).
Glib::PropertyProxy_ReadOnly< int > property_bitrate () const
 Attempt to encode at a bitrate averaging this (in bps).
Glib::PropertyProxy< int > property_min_bitrate ()
 Specify a minimum bitrate (in bps).
Glib::PropertyProxy_ReadOnly< int > property_min_bitrate () const
 Specify a minimum bitrate (in bps).
Glib::PropertyProxy< float > property_quality ()
 Specify quality instead of specifying a particular bitrate.
Glib::PropertyProxy_ReadOnly
< float > 
property_quality () const
 Specify quality instead of specifying a particular bitrate.
Glib::PropertyProxy< bool > property_managed ()
 Enable bitrate management engine.
Glib::PropertyProxy_ReadOnly
< bool > 
property_managed () const
 Enable bitrate management engine.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_last_message () const
 The last status message.

Static Public Member Functions

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

Protected Member Functions

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

Related Functions

(Note that these are not member functions.)



Glib::RefPtr< Gst::VorbisEncwrap (GstVorbisEnc* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

A Wrapper for the vorbisenc plugin.

Please note that, 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. Also, not all plug-ins are available on all systems so care must be taken that they exist before they are used, otherwise there will be errors and possibly a crash.


Constructor & Destructor Documentation

virtual Gst::VorbisEnc::~VorbisEnc (  )  [virtual]
Gst::VorbisEnc::VorbisEnc (  )  [protected]
Gst::VorbisEnc::VorbisEnc ( const Glib::ustring &  name  )  [explicit, protected]

Member Function Documentation

static Glib::RefPtr<VorbisEnc> Gst::VorbisEnc::create ( const Glib::ustring &  name  )  [static]

Creates a new vorbisenc plugin with the given name.

static Glib::RefPtr<VorbisEnc> Gst::VorbisEnc::create (  )  [static]

Creates a new vorbisenc plugin with a unique name.

const GstVorbisEnc* Gst::VorbisEnc::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

GstVorbisEnc* Gst::VorbisEnc::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

GstVorbisEnc* Gst::VorbisEnc::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.

Glib::PropertyProxy_ReadOnly<int> Gst::VorbisEnc::property_bitrate (  )  const

Attempt to encode at a bitrate averaging this (in bps).

This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled).

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> Gst::VorbisEnc::property_bitrate (  ) 

Attempt to encode at a bitrate averaging this (in bps).

This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled).

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> Gst::VorbisEnc::property_last_message (  )  const

The last status message.

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> Gst::VorbisEnc::property_managed (  )  const

Enable bitrate management engine.

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> Gst::VorbisEnc::property_managed (  ) 

Enable bitrate management engine.

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> Gst::VorbisEnc::property_max_bitrate (  )  const

Specify a maximum bitrate (in bps).

Useful for streaming applications. (-1 == disabled).

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> Gst::VorbisEnc::property_max_bitrate (  ) 

Specify a maximum bitrate (in bps).

Useful for streaming applications. (-1 == disabled).

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> Gst::VorbisEnc::property_min_bitrate (  )  const

Specify a minimum bitrate (in bps).

Useful for encoding for a fixed-size channel. (-1 == disabled).

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> Gst::VorbisEnc::property_min_bitrate (  ) 

Specify a minimum bitrate (in bps).

Useful for encoding for a fixed-size channel. (-1 == disabled).

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<float> Gst::VorbisEnc::property_quality (  )  const

Specify quality instead of specifying a particular bitrate.

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<float> Gst::VorbisEnc::property_quality (  ) 

Specify quality instead of specifying a particular bitrate.

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< Gst::VorbisEnc > wrap ( GstVorbisEnc *  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 Mon May 24 15:28:42 2010 for gstreamermm by  doxygen 1.6.3