gstreamermm: Gst::AudioBaseSrc Class Reference

gstreamermm 1.10.0

Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gst::AudioBaseSrc Class Reference
gstreamermm Base Classes

The base class for audio sources. More...

`#include <gstreamermm/audiobasesrc.h>`

Inheritance diagram for Gst::AudioBaseSrc:
[legend]

## Public Member Functions
| AudioBaseSrc (AudioBaseSrc&& src) noexcept
AudioBaseSrc& | operator= (AudioBaseSrc&& src) noexcept
| ~AudioBaseSrc () noexcept override
GstAudioBaseSrc* | gobj ()
| Provides access to the underlying C GObject. More...
const GstAudioBaseSrc* | gobj () const
| Provides access to the underlying C GObject. More...
GstAudioBaseSrc* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
Glib::RefPtr< Gst::Clock > | get_clock ()
| Get the Gst::Clock of the Gst::AudioSrc. More...
Glib::RefPtr< const Gst::Clock > | get_clock () const
Glib::RefPtr< Gst::AudioRingBuffer > | create_ring_buffer ()
| Create and return the Gst::AudioRingBuffer for src. More...
void | set_provide_clock (bool provide)
| Controls whether src will provide a clock or not. More...
bool | get_provide_clock () const
| Queries whether src will provide a clock or not. More...
void | set_slave_method (Gst::AudioBaseSrcSlaveMethod method)
| Controls how clock slaving will be performed in src. More...
Gst::AudioBaseSrcSlaveMethod | get_slave_method () const
| Get the current slave method used by src. More...
Glib::PropertyProxy_ReadOnly< gint64 > | property_actual_buffer_time () const
| Actual configured size of audio buffer in microseconds. More...
Glib::PropertyProxy_ReadOnly< gint64 > | property_actual_latency_time () const
| Actual configured audio latency in microseconds. More...
Glib::PropertyProxy< gint64 > | property_buffer_time ()
| Size of audio buffer in microseconds. More...
Glib::PropertyProxy_ReadOnly< gint64 > | property_buffer_time () const
| Size of audio buffer in microseconds. More...
Glib::PropertyProxy< gint64 > | property_latency_time ()
| The minimum amount of data to read in each iteration in microseconds. More...
Glib::PropertyProxy_ReadOnly< gint64 > | property_latency_time () const
| The minimum amount of data to read in each iteration in microseconds. More...
Glib::PropertyProxy< bool > | property_provide_clock ()
| Provide a clock to be used as the global pipeline clock. More...
Glib::PropertyProxy_ReadOnly< bool > | property_provide_clock () const
| Provide a clock to be used as the global pipeline clock. More...
Glib::PropertyProxy< AudioBaseSrcSlaveMethod > | property_slave_method ()
| Algorithm used to match the rate of the masterclock. More...
Glib::PropertyProxy_ReadOnly< AudioBaseSrcSlaveMethod > | property_slave_method () const
| Algorithm used to match the rate of the masterclock. More...
virtual Glib::RefPtr< Gst::AudioRingBuffer > | create_ring_buffer_vfunc ()
| vfunc to create and return a Gst::AudioRingBuffer to read from. More...
Public Member Functions inherited from Gst::PushSrc
| PushSrc (PushSrc&& src) noexcept
PushSrc& | operator= (PushSrc&& src) noexcept
| ~PushSrc () noexcept override
GstPushSrc* | gobj ()
| Provides access to the underlying C GObject. More...
const GstPushSrc* | gobj () const
| Provides access to the underlying C GObject. More...
GstPushSrc* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
Public Member Functions inherited from Gst::BaseSrc
| BaseSrc (BaseSrc&& src) noexcept
BaseSrc& | operator= (BaseSrc&& src) noexcept
| ~BaseSrc () noexcept override
GstBaseSrc* | gobj ()
| Provides access to the underlying C GObject. More...
const GstBaseSrc* | gobj () const
| Provides access to the underlying C GObject. More...
GstBaseSrc* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
FlowReturn | wait_playing ()
| If the Gst::BaseSrcClass.create() method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED state and call this method before continuing to produce the remaining data. More...
bool | is_live () const
| Check if an element is in live mode. More...
void | set_live (bool live)
| If the element listens to a live source, live should be set to `true`. More...
void | set_format (Format format)
| Sets the default format of the source. More...
bool | query_latency (bool& live, Gst::ClockTime& min_latency, Gst::ClockTime& max_latency) const
| Query the source for the latency parameters. More...
guint | get_blocksize () const
| Get the number of bytes that src will push out with each buffer. More...
void | set_blocksize (guint blocksize)
| Set the number of bytes that src will push out with each buffer. More...
bool | get_do_timestamp () const
| Query if src timestamps outgoing buffers based on the current running_time. More...
void | set_do_timestamp (bool timestamp)
| Configure src to automatically timestamp outgoing buffers based on the current running_time of the pipeline. More...
bool | new_seamless_segment (gint64 start, gint64 stop, gint64 position)
| Prepare a new seamless segment for emission downstream. More...
bool | set_caps (const Glib::RefPtr< Gst::Caps >& caps)
| Set new caps on the basesrc source pad. More...
Gst::FlowReturn | start_wait ()
| Wait until the start operation completes. More...
void | set_dynamic_size (bool dynamic_size)
| If not dynamic_size, size is only updated when needed, such as when trying to read past current tracked size. More...
void | set_async (bool async)
| Configure async behaviour in src, no state change will block. More...
bool | is_async () const
| Get the current async behaviour of src. More...
void | start_complete (Gst::FlowReturn ret)
| Complete an asynchronous start operation. More...
void | set_automatic_eos (bool automatic_eos)
| If automatic_eos is `true`, src will automatically go EOS if a buffer after the total size is returned. More...
Glib::RefPtr< Gst::Allocator > | get_allocator (Gst::AllocationParams& params)
| Returns the memory allocator used by the base class and its params. More...
Glib::RefPtr< Gst::Pad > | get_src_pad ()
| Gets the source Gst::Pad object of the element. More...
Glib::RefPtr< const Gst::Pad > | get_src_pad () const
Glib::PropertyProxy< gulong > | property_blocksize ()
| Size in bytes to read per buffer (-1 = default). More...
Glib::PropertyProxy_ReadOnly< gulong > | property_blocksize () const
| Size in bytes to read per buffer (-1 = default). More...
Glib::PropertyProxy< bool > | property_do_timestamp ()
| Apply current stream time to buffers. More...
Glib::PropertyProxy_ReadOnly< bool > | property_do_timestamp () const
| Apply current stream time to buffers. More...
Glib::PropertyProxy< int > | property_num_buffers ()
| Number of buffers to output before sending EOS (-1 = unlimited). More...
Glib::PropertyProxy_ReadOnly< int > | property_num_buffers () const
| Number of buffers to output before sending EOS (-1 = unlimited). More...
Glib::PropertyProxy< bool > | property_typefind ()
| Run typefind before negotiating. More...
Glib::PropertyProxy_ReadOnly< bool > | property_typefind () const
| Run typefind before negotiating. More...
virtual Glib::RefPtr< Gst::Caps > | get_caps_vfunc (const Glib::RefPtr< Gst::Caps >& caps) const
| Called to get the caps to report. More...
virtual bool | set_caps_vfunc (const Glib::RefPtr< Gst::Caps >& caps)
| Notify subclass of changed output caps. More...
virtual bool | negotiate_vfunc ()
| Negotiated the caps with the peer. More...
virtual bool | stop_vfunc ()
| Stop processing. More...
virtual bool | start_vfunc ()
| Start processing. More...
virtual void | get_times_vfunc (const Glib::RefPtr< Gst::Buffer >& buffer, Gst::ClockTime&start, Gst::ClockTime&end) const
| Given a buffer, return the start and stop time when it should be pushed out. More...
virtual bool | get_size_vfunc (guint64&size) const
| Return the total size of the resource, in the configured format. More...
virtual bool | is_seekable_vfunc () const
| Check if the source can seek. More...
virtual bool | unlock_vfunc ()
| Unlock any pending access to the resource. More...
virtual bool | event_vfunc (const Glib::RefPtr< Gst::Event >& event)
| Override this to implement custom event handling. More...
virtual FlowReturn | create_vfunc (guint64 offset, guint size, Glib::RefPtr< Gst::Buffer >& buffer)
virtual bool | do_seek_vfunc (Gst::Segment& segment)
| Perform seeking on the resource to the indicated segment. More...
virtual bool | base_src_query_vfunc (const Glib::RefPtr< Gst::Query >&query)
| Handle a requested query. More...
virtual Glib::RefPtr< Gst::Caps > | fixate_vfunc (const Glib::RefPtr< Gst::Caps >& caps)
| Called during negotiation if caps need fixating. More...
virtual bool | unlock_stop_vfunc ()
| Clear the previous unlock request. More...
virtual bool | prepare_seek_segment_vfunc (const Glib::RefPtr< Gst::Event >&seek, Gst::Segment& segment)
| Prepare the Gst::Segment that will be passed to the do_seek_vfunc() vmethod for executing a seek request. More...
virtual bool | decide_allocation_vfunc (const Glib::RefPtr< Gst::Query >&query)
| Configure the allocation query. More...
Gst::FlowReturn | alloc_vfunc (guint64 offset, guint size, Glib::RefPtr< Gst::Buffer >& buffer)
| Ask the subclass to allocate a buffer with for offset and size. More...
virtual Gst::FlowReturn | fill_vfunc (guint64 offset, guint size, const Glib::RefPtr< Gst::Buffer >& buffer)
| Ask the subclass to fill the buffer with data for offset and size. More...
Public Member Functions inherited from Gst::Element
| Element (Element&& src) noexcept
Element& | operator= (Element&& src) noexcept
| ~Element () noexcept override
GstElement* | gobj ()
| Provides access to the underlying C GObject. More...
const GstElement* | gobj () const
| Provides access to the underlying C GObject. More...
GstElement* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
Glib::RefPtr< Gst::Element > | link (const Glib::RefPtr< Gst::Element >& dest)
| Links this source element to the dest element. More...
bool | add_pad (const Glib::RefPtr< Gst::Pad >& pad)
| Adds a pad (link point) to element. More...
void | create_all_pads ()
| Creates a pad for each pad template that is always available. More...
Glib::RefPtr< Gst::Pad > | create_compatible_pad (const Glib::RefPtr< const Gst::Pad >& pad, const Glib::RefPtr< const Gst::Caps >& caps)
| Looks for an unlinked pad to which the given pad can link. More...
Glib::RefPtr< Gst::PadTemplate > | get_compatible_pad_template (const Glib::RefPtr< const Gst::PadTemplate >& compattempl)
| Retrieves a pad template from element that is compatible with compattempl. More...
Glib::RefPtr< const Gst::PadTemplate > | get_compatible_pad_template (const Glib::RefPtr< const Gst::PadTemplate >& compattempl) const
| Retrieves a pad template from element that is compatible with compattempl. More...
Glib::RefPtr< Gst::Pad > | get_request_pad (const Glib::ustring& name)
| Retrieves a pad from the element by name (e.g. "src_\\%d"). More...
Glib::RefPtr< Gst::Pad > | request_pad (const Glib::RefPtr< Gst::PadTemplate >& templ, const Glib::ustring& name, const Glib::RefPtr< const Gst::Caps >& caps)
| Retrieves a request pad from the element according to the provided template. More...
Glib::RefPtr< Gst::Pad > | request_pad (const Glib::RefPtr< Gst::PadTemplate >& templ, const Glib::ustring& name)
| A request_pad() convenience overload. More...
Glib::RefPtr< Gst::Pad > | request_pad (const Glib::RefPtr< Gst::PadTemplate >& templ, const Glib::RefPtr< const Gst::Caps >& caps)
| A request_pad() convenience overload. More...
Glib::RefPtr< Gst::Pad > | request_pad (const Glib::RefPtr< Gst::PadTemplate >& templ)
| A request_pad() convenience overload. More...
Glib::RefPtr< Gst::Pad > | get_static_pad (const Glib::ustring& name)
| Retrieves a pad from element by name. More...
Glib::RefPtr< const Gst::Pad > | get_static_pad (const Glib::ustring& name) const
| Retrieves a pad from element by name. More...
void | no_more_pads ()
| Use this function to signal that the element does not expect any more pads to show up in the current pipeline. More...
void | release_request_pad (const Glib::RefPtr< Gst::Pad >& pad)
| Makes the element free the previously requested pad as obtained with get_request_pad(). More...
bool | remove_pad (const Glib::RefPtr< Gst::Pad >& pad)
| Removes pad from element. More...
Gst::Iterator< Gst::Pad > | iterate_pads ()
| Retrieves an iterator of element's pads. More...
Gst::Iterator< const Gst::Pad > | iterate_pads () const
| Retrieves an iterator of element's pads. More...
Gst::Iterator< Gst::Pad > | iterate_sink_pads ()
| Retrieves an iterator of element's sink pads. More...
Gst::Iterator< const Gst::Pad > | iterate_sink_pads () const
| Retrieves an iterator of element's sink pads. More...
Gst::Iterator< Gst::Pad > | iterate_src_pads ()
| Retrieves an iterator of element's source pads. More...
Gst::Iterator< const Gst::Pad > | iterate_src_pads () const
| Retrieves an iterator of element's source pads. More...
void | unlink (const Glib::RefPtr< Gst::Element >& dest)
| Unlinks all source pads of the source element with all sink pads of the sink element to which they are linked. More...
void | set_context (const Glib::RefPtr< Gst::Context >& context)
| Sets the context of the element. More...
bool | link_pads (const Glib::ustring& srcpadname, const Glib::RefPtr< Gst::Element >& dest, const Glib::ustring& destpadname)
| Links the two named pads of the source and destination elements. More...
void | unlink_pads (const Glib::ustring& srcpadname, const Glib::RefPtr< Gst::Element >& dest, const Glib::ustring& destpadname)
| Unlinks the two named pads of the source and destination elements. More...
bool | link_pads (const Glib::ustring& srcpadname, const Glib::RefPtr< Gst::Element >& dest, const Glib::ustring& destpadname, const Glib::RefPtr< Gst::Caps >& filter)
| Links the two named pads of the source and destination elements. More...
bool | link_pads (const Glib::ustring& srcpadname, const Glib::RefPtr< Gst::Element >& dest, const Glib::ustring& destpadname, PadLinkCheck flags)
| Links the two named pads of the source and destination elements. More...
Glib::RefPtr< Gst::Element > | link (const Glib::RefPtr< Gst::Element >& dest, const Glib::RefPtr< Gst::Caps >& filter)
| Links src to dest using the given caps as filtercaps. More...
void | set_base_time (ClockTime time)
| Set the base time of an element. More...
ClockTime | get_base_time () const
| Returns the base time of the element. More...
void | set_start_time (Gst::ClockTime time)
| Set the start time of an element. More...
Gst::ClockTime | get_start_time () const
| Returns the start time of the element. More...
void | set_bus (const Glib::RefPtr< Gst::Bus >& bus)
| Sets the bus of the element. More...
Glib::RefPtr< Gst::Bus > | get_bus ()
| Returns the bus of the element. More...
Glib::RefPtr< const Gst::Bus > | get_bus () const
| Returns the bus of the element. More...
Glib::RefPtr< Gst::ElementFactory > | get_factory ()
| Retrieves the factory that was used to create this element. More...
Glib::RefPtr< const Gst::ElementFactory > | get_factory () const
| Retrieves the factory that was used to create this element. More...
bool | set_clock (const Glib::RefPtr< Gst::Clock >& clock)
| Sets the clock for the element. More...
Glib::RefPtr< Gst::Clock > | get_clock ()
| Gets the currently configured clock of the element. More...
Glib::RefPtr< const Gst::Clock > | get_clock () const
| Gets the currently configured clock of the element. More...
Glib::RefPtr< Gst::Clock > | provide_clock ()
| Get the clock provided by the given element. More...
Glib::RefPtr< const Gst::Clock > | provide_clock () const
| Get the clock provided by the given element. More...
StateChangeReturn | set_state (State state)
| Sets the state of the element. More...
StateChangeReturn | get_state (State& state, State& pending, ClockTime timeout) const
| Gets the state of the element. More...
bool | set_locked_state (gboolean locked_state)
| Locks the state of an element, so state changes of the parent don't affect this element anymore. More...
bool | is_locked_state () const
| Checks if the state of an element is locked. More...
void | abort_state ()
| Abort the state change of the element. More...
StateChangeReturn | continue_state (StateChangeReturn ret)
| Commit the state change of the element and proceed to the next pending state if any. More...
void | lost_state ()
| Brings the element to the lost state. More...
bool | sync_state_with_parent ()
| Tries to change the state of the element to the same as its parent. More...
StateChangeReturn | change_state (StateChange transition)
| Perform transition on element. More...
void | post_message (int code, int line, MessageType type=Gst::MESSAGE_INFO, const Glib::QueryQuark& domain=get_core_error_quark(), const Glib::ustring& text=Glib::ustring(), const Glib::ustring& debug=Glib::ustring(), const Glib::ustring& file=Glib::ustring(), const Glib::ustring& function=Glib::ustring())
| Post an error, warning or info message on the bus from inside an element. More...
bool | post_message (Glib::RefPtr< Gst::Message >&& message)
| Post a message on the element's Gst::Bus. More...
bool | query (const Glib::RefPtr< Gst::Query >& query) const
| Performs a query on the given element. More...
bool | query_convert (Gst::Format src_format, gint64 src_val, Format dest_format, gint64& dest_val) const
| Queries an element to convert src_val in src_format to dest_format. More...
bool | query_position (Gst::Format format, gint64& cur) const
| Queries an element (usually top-level pipeline or playbin element) for the stream position in nanoseconds. More...
bool | query_position (Gst::Format format) const
| A query_position() convenience overload. More...
bool | query_duration (Gst::Format format, gint64& duration) const
| Queries an element (usually top-level pipeline or playbin element) for the total stream duration in nanoseconds. More...
bool | query_duration (Gst::Format format) const
| A query_duration() convenience overload. More...
bool | seek (Format format, SeekFlags seek_flags, gint64 seek_pos)
| Simple API to perform a seek on the given element, meaning it just seeks to the given position relative to the start of the stream. More...
bool | seek (double rate, Format format, SeekFlags flags, SeekType cur_type, gint64 cur, SeekType stop_type, gint64 stop)
| Sends a seek event to an element. More...
bool | send_event (Glib::RefPtr< Gst::Event >&& event)
| Sends an event to an element. More...
bool | send_event (const Glib::RefPtr< Gst::Event >& event)
| A send_event() convenience overload. Allows to re-use event parameter after function call. More...
Glib::RefPtr< Gst::Context > | get_context (const Glib::ustring& context_type)
| Gets the context with context_type set on the element or `nullptr`. More...
Glib::RefPtr< Gst::Context > | get_context_unlocked (const Glib::ustring& context_type)
| Gets the context with context_type set on the element or `nullptr`. More...
std::vector< Glib::RefPtr< Gst::Context > > | get_contexts ()
| Gets the contexts set on the element. More...
Glib::SignalProxy< void > | signal_no_more_pads ()
Glib::SignalProxy< void, const Glib::RefPtr< Gst::Pad >&> | signal_pad_added ()
Glib::SignalProxy< void, const Glib::RefPtr< Gst::Pad >&> | signal_pad_removed ()
virtual void | release_pad_vfunc (const Glib::RefPtr< Gst::Pad >& pad)
| Called when a request pad is to be released. More...
virtual Glib::RefPtr< Gst::Pad > | request_new_pad_vfunc (Glib::RefPtr< Gst::PadTemplate > templ, const Glib::ustring& name, const Glib::RefPtr< const Gst::Caps >& caps)
| Called when a new pad is requested. More...
virtual StateChangeReturn | get_state_vfunc (State& state, State& pending, ClockTime timeout) const
| Get the state of the element. More...
virtual StateChangeReturn | set_state_vfunc (State state)
| Set a new state on the element. More...
virtual StateChangeReturn | change_state_vfunc (StateChange transition)
| Called by set_state to perform an incremental state change. More...
virtual void | state_changed_vfunc (Gst::State oldstate, Gst::State newstate, Gst::State pending)
| Called immediately after a new state was set. More...
virtual void | set_bus_vfunc (const Glib::RefPtr< Gst::Bus >& bus)
| Set a Gst::Bus on the element. More...
virtual Glib::RefPtr< Gst::Clock > | provide_clock_vfunc ()
| Gets the Gst::Clock provided by the element. More...
virtual bool | set_clock_vfunc (const Glib::RefPtr< Gst::Clock >& clock)
| Set the Gst::Clock on the element. More...
virtual bool | send_event_vfunc (const Glib::RefPtr< Gst::Event >& event)
| Send a Gst::Event to the element. More...
virtual bool | query_vfunc (const Glib::RefPtr< Gst::Query >&query) const
| Perform a Gst::Query on the element. More...
virtual void | set_context_vfunc (const Glib::RefPtr< Gst::Context >& context)
| Set a Gst::Context on the element. More...
virtual bool | post_message_vfunc (const Glib::RefPtr< Gst::Message >& message)
| Called when a message is posted on the element. More...
Glib::RefPtr< Gst::PadTemplate > | get_pad_template (const Glib::ustring& factory_name) const
template<typename T >
Glib::RefPtr< Gst::Element > | property (const Glib::ustring& name, const T& value)
| Sets specified property. More...
Public Member Functions inherited from Gst::Object
| Object (Object&& src) noexcept
Object& | operator= (Object&& src) noexcept
| ~Object () noexcept override
GstObject* | gobj ()
| Provides access to the underlying C GObject. More...
const GstObject* | gobj () const
| Provides access to the underlying C GObject. More...
GstObject* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
bool | is_element () const
bool | is_element_factory () const
bool | is_pad () const
bool | is_pad_template () const
bool | is_bin () const
guint32 | get_flags () const
| Returns the entire set of flags for the object. More...
bool | set_name (const Glib::ustring& name)
| Sets the name of object, or gives object a guaranteed unique name (if name is `nullptr`). More...
Glib::ustring | get_name () const
| Returns a copy of the name of object. More...
bool | set_parent (const Glib::RefPtr< Gst::Object >& parent)
| Sets the parent of object to parent. More...
Glib::RefPtr< Gst::Object > | get_parent ()
| Returns the parent of object. More...
Glib::RefPtr< const Gst::Object > | get_parent () const
| Returns the parent of object. More...
void | unparent ()
| Clear the parent of object, removing the associated reference. More...
void | set_control_rate (Gst::ClockTime control_rate)
| Change the control-rate for this object. More...
Gst::ClockTime | get_control_rate () const
| Obtain the control-rate for this object. More...
Gst::ClockTime | suggest_next_sync () const
| Returns a suggestion for timestamps where buffers should be split to get best controller results. More...
bool | sync_values (Gst::ClockTime timestamp)
| Sets the properties of the object, according to the Gst::ControlSources that (maybe) handle them and for the given timestamp. More...
void | set_control_bindings_disabled (bool disabled)
| This function is used to disable all controlled properties of the object for some time, i.e. sync_values() will do nothing. More...
bool | has_asctive_control_bindings () const
| Check if the object has an active controlled properties. More...
bool | has_ancestor (const Glib::RefPtr< const Gst::Object >& ancestor) const
| Check if object has an ancestor ancestor somewhere up in the hierarchy. More...
bool | has_as_ancestor (const Glib::RefPtr< Gst::Object >& ancestor) const
| Check if object has an ancestor ancestor somewhere up in the hierarchy. More...
bool | has_as_parent (const Glib::RefPtr< Gst::Object >& parent) const
| Check if parent is the parent of object. More...
Glib::ustring | get_path_string ()
| Generates a string describing the path of object in the object hierarchy. More...
Glib::PropertyProxy< Glib::ustring > | property_name ()
| The name of the object. More...
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const
| The name of the object. More...
Glib::PropertyProxy< Glib::RefPtr< Gst::Object > > | property_parent ()
| The parent of the object. More...
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gst::Object > > | property_parent () const
| The parent of the object. More...
Glib::SignalProxy< void, const Glib::RefPtr< Gst::Object >&, GParamSpec*> | signal_deep_notify ()
int | get_refcount () const

## Static Public Member Functions
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Gst::PushSrc
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Gst::BaseSrc
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Gst::Element
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Gst::Object
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
static bool | check_uniqueness (const Glib::ListHandle< const Gst::Object >& list, const Glib::ustring& name)
| Checks to see if there is any object named name in list. More...

## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gst::AudioBaseSrc > | wrap (GstAudioBaseSrc* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::PushSrc
Glib::RefPtr< Gst::PushSrc > | wrap (GstPushSrc* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::BaseSrc
Glib::RefPtr< Gst::BaseSrc > | wrap (GstBaseSrc* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::Element
Glib::RefPtr< Gst::Element > | wrap (GstElement* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::Object
Glib::RefPtr< Gst::Object > | wrap (GstObject* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Additional Inherited Members
Protected Member Functions inherited from Gst::Element
virtual void | on_no_more_pads ()
| This is a default handler for the signal signal_no_more_pads(). More...
virtual void | on_pad_added (const Glib::RefPtr< Gst::Pad >& new_pad)
| This is a default handler for the signal signal_pad_added(). More...
virtual void | on_pad_removed (const Glib::RefPtr< Gst::Pad >& old_pad)
| This is a default handler for the signal signal_pad_removed(). More...
Protected Member Functions inherited from Gst::Object
virtual void | on_deep_notify (const Glib::RefPtr< Gst::Object >& prop_object, GParamSpec* prop)
| This is a default handler for the signal signal_deep_notify(). More...

## Detailed Description

The 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 audioringbuffer, synchronisation and flushing.

Last reviewed on 2016-04-23 (1.8.0).

## Constructor & Destructor Documentation

## ◆ AudioBaseSrc()

Gst::AudioBaseSrc::AudioBaseSrc | ( | AudioBaseSrc&& | src | ) |
| noexcept

## ◆ ~AudioBaseSrc()

Gst::AudioBaseSrc::~AudioBaseSrc | ( |  | ) |
| overridenoexcept

## Member Function Documentation

## ◆ create_ring_buffer()

Glib::RefPtr<Gst::AudioRingBuffer> Gst::AudioBaseSrc::create_ring_buffer | ( |  | ) |

Create and return the Gst::AudioRingBuffer for src.

This function will call the ::create_ringbuffer vmethod and will set src as the parent of the returned buffer (see Gst::Object::set_parent()).

Returns
  The new ringbuffer of src.

## ◆ create_ring_buffer_vfunc()

virtual Glib::RefPtr<Gst::AudioRingBuffer> Gst::AudioBaseSrc::create_ring_buffer_vfunc | ( |  | ) |
| virtual

vfunc to create and return a Gst::AudioRingBuffer to read from.

## ◆ get_clock() [1/2]

Glib::RefPtr<Gst::Clock> Gst::AudioBaseSrc::get_clock | ( |  | ) |

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

## ◆ get_clock() [2/2]

Glib::RefPtr<const Gst::Clock> Gst::AudioBaseSrc::get_clock | ( |  | ) | const

## ◆ get_provide_clock()

bool Gst::AudioBaseSrc::get_provide_clock | ( |  | ) | const

Queries whether src will provide a clock or not.

See also gst_audio_base_src_set_provide_clock.

Returns
  `true` if src will provide a clock.

## ◆ get_slave_method()

Gst::AudioBaseSrcSlaveMethod Gst::AudioBaseSrc::get_slave_method | ( |  | ) | const

Get the current slave method used by src.

Returns
  The current slave method used by src.

## ◆ get_type()

static GType Gst::AudioBaseSrc::get_type | ( |  | ) |
| static

Get the GType for this class, for use with the underlying GObject type system.

## ◆ gobj() [1/2]

GstAudioBaseSrc* Gst::AudioBaseSrc::gobj | ( |  | ) |
| inline

Provides access to the underlying C GObject.

## ◆ gobj() [2/2]

const GstAudioBaseSrc* Gst::AudioBaseSrc::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GObject.

## ◆ gobj_copy()

GstAudioBaseSrc* Gst::AudioBaseSrc::gobj_copy | ( |  | ) |

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

## ◆ operator=()

AudioBaseSrc& Gst::AudioBaseSrc::operator= | ( | AudioBaseSrc&& | src | ) |
| noexcept

## ◆ property_actual_buffer_time()

Glib::PropertyProxy_ReadOnly< gint64 > Gst::AudioBaseSrc::property_actual_buffer_time | ( |  | ) | const

Actual configured size of audio buffer in microseconds.

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

## ◆ property_actual_latency_time()

Glib::PropertyProxy_ReadOnly< gint64 > Gst::AudioBaseSrc::property_actual_latency_time | ( |  | ) | const

Actual configured audio latency in microseconds.

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

## ◆ property_buffer_time() [1/2]

Glib::PropertyProxy< gint64 > Gst::AudioBaseSrc::property_buffer_time | ( |  | ) |

Size of audio buffer in microseconds.

This is the maximum amount of data that is buffered in the device and the maximum latency that the source reports. This value might be ignored by the element if necessary; see 'actual-buffer-time'.

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

## ◆ property_buffer_time() [2/2]

Glib::PropertyProxy_ReadOnly< gint64 > Gst::AudioBaseSrc::property_buffer_time | ( |  | ) | const

Size of audio buffer in microseconds.

This is the maximum amount of data that is buffered in the device and the maximum latency that the source reports. This value might be ignored by the element if necessary; see 'actual-buffer-time'.

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

## ◆ property_latency_time() [1/2]

Glib::PropertyProxy< gint64 > Gst::AudioBaseSrc::property_latency_time | ( |  | ) |

The minimum amount of data to read in each iteration in microseconds.

This is the minimum latency that the source reports. This value might be ignored by the element if necessary; see 'actual-latency-time'.

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

## ◆ property_latency_time() [2/2]

Glib::PropertyProxy_ReadOnly< gint64 > Gst::AudioBaseSrc::property_latency_time | ( |  | ) | const

The minimum amount of data to read in each iteration in microseconds.

This is the minimum latency that the source reports. This value might be ignored by the element if necessary; see 'actual-latency-time'.

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

## ◆ property_provide_clock() [1/2]

Glib::PropertyProxy< bool > Gst::AudioBaseSrc::property_provide_clock | ( |  | ) |

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

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

## ◆ property_provide_clock() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gst::AudioBaseSrc::property_provide_clock | ( |  | ) | const

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

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

## ◆ property_slave_method() [1/2]

Glib::PropertyProxy< AudioBaseSrcSlaveMethod > Gst::AudioBaseSrc::property_slave_method | ( |  | ) |

Algorithm used to match the rate of the masterclock.

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

## ◆ property_slave_method() [2/2]

Glib::PropertyProxy_ReadOnly< AudioBaseSrcSlaveMethod > Gst::AudioBaseSrc::property_slave_method | ( |  | ) | const

Algorithm used to match the rate of the masterclock.

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

## ◆ set_provide_clock()

void Gst::AudioBaseSrc::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 `nullptr`.

Parameters

  provide | New state.

## ◆ set_slave_method()

void Gst::AudioBaseSrc::set_slave_method | ( | Gst::AudioBaseSrcSlaveMethod | method | ) |

Controls how clock slaving will be performed in src.

Parameters

  method | The new slave method.

## Friends And Related Function Documentation

## ◆ wrap()

Glib::RefPtr< Gst::AudioBaseSrc > wrap | ( | GstAudioBaseSrc * | 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.