GstBase::BaseAudioSrc Class Reference
[gstreamerbasemm Base Classes]

GstBase::BaseAudioSrc — Base class for audio sources. More...

#include <baseaudiosrc.h>

Inheritance diagram for GstBase::BaseAudioSrc:

Gst::PushSrc Gst::BaseSrc Gst::Element Gst::Object GstBase::AudioSrc GstBase::AlsaSrc

List of all members.

Public Member Functions

virtual ~BaseAudioSrc ()
GstBaseAudioSrc* gobj ()
 Provides access to the underlying C GObject.
const GstBaseAudioSrc* gobj () const
 Provides access to the underlying C GObject.
GstBaseAudioSrc* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr<Gst::Clockget_clock () const
 Get the Gst::Clock of the GstBase::AudioSrc.
void set_provide_clock (bool provide)
 Controls whether src will provide a clock or not.
bool get_provide_clock ()
 Queries whether src will provide a clock or not.
Glib::PropertyProxy_ReadOnly
<gint64> 
property_actual_buffer_time () const
 Actual configured size of audio buffer in microseconds.
Glib::PropertyProxy_ReadOnly
<gint64> 
property_actual_latency_time () const
 Actual configured audio latency in microseconds.
Glib::PropertyProxy<gint64> property_buffer_time ()
 Size of audio buffer in microseconds.
Glib::PropertyProxy_ReadOnly
<gint64> 
property_buffer_time () const
 Size of audio buffer in microseconds.
Glib::PropertyProxy<gint64> property_latency_time ()
 Audio latency in microseconds.
Glib::PropertyProxy_ReadOnly
<gint64> 
property_latency_time () const
 Audio latency in microseconds.
Glib::PropertyProxy<bool> property_provide_clock ()
 Provide a clock to be used as the global pipeline clock.
Glib::PropertyProxy_ReadOnly
<bool> 
property_provide_clock () const
 Provide a clock to be used as the global pipeline clock.

Related Functions

(Note that these are not member functions.)

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


Detailed Description

GstBase::BaseAudioSrc — Base class for audio sources.

This is the base class for audio sources. Subclasses need to implement the create_ringbuffer_vfunc vmethod. This base class will then take care of reading samples from the ringbuffer, synchronisation and flushing.

Last reviewed on 2006-09-27 (0.10.12).


Constructor & Destructor Documentation

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


Member Function Documentation

Glib::RefPtr<Gst::Clock> GstBase::BaseAudioSrc::get_clock (  )  const

Get the Gst::Clock of the GstBase::AudioSrc.

Reimplemented from Gst::Element.

bool GstBase::BaseAudioSrc::get_provide_clock (  ) 

Queries whether src will provide a clock or not.

See also gst_base_audio_src_set_provide_clock.

Returns:
true if src will provide a clock.
Since: 0.10.16.

const GstBaseAudioSrc* GstBase::BaseAudioSrc::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::PushSrc.

Reimplemented in GstBase::AlsaSrc, and GstBase::AudioSrc.

GstBaseAudioSrc* GstBase::BaseAudioSrc::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::PushSrc.

Reimplemented in GstBase::AlsaSrc, and GstBase::AudioSrc.

GstBaseAudioSrc* GstBase::BaseAudioSrc::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::PushSrc.

Reimplemented in GstBase::AlsaSrc, and GstBase::AudioSrc.

Glib::PropertyProxy_ReadOnly<gint64> GstBase::BaseAudioSrc::property_actual_buffer_time (  )  const

Actual configured size of audio buffer in microseconds.

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<gint64> GstBase::BaseAudioSrc::property_actual_latency_time (  )  const

Actual configured audio latency in microseconds.

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<gint64> GstBase::BaseAudioSrc::property_buffer_time (  )  const

Size of audio buffer in microseconds.

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<gint64> GstBase::BaseAudioSrc::property_buffer_time (  ) 

Size of audio buffer in microseconds.

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<gint64> GstBase::BaseAudioSrc::property_latency_time (  )  const

Audio latency in microseconds.

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<gint64> GstBase::BaseAudioSrc::property_latency_time (  ) 

Audio latency in microseconds.

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::BaseAudioSrc::property_provide_clock (  )  const

Provide a clock to be used as the global pipeline clock.

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::BaseAudioSrc::property_provide_clock (  ) 

Provide a clock to be used as the global pipeline clock.

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.

void GstBase::BaseAudioSrc::set_provide_clock ( bool  provide  ) 

Controls whether src will provide a clock or not.

If provide is true, gst_element_provide_clock() will return a clock that reflects the datarate of src. If provide is false, gst_element_provide_clock() will return 0.

Since: 0.10.16

Parameters:
provide New state.


Friends And Related Function Documentation

Glib::RefPtr<GstBase::BaseAudioSrc> wrap ( GstBaseAudioSrc *  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:13 2009 for gstreamermm by  doxygen 1.5.7.1