Abort the state change of the element. This function is used by elements that do asynchronous state changes and find out something is wrong. This function should be called with the STATE_LOCK held. MT safe.

Returns:

none

Adds a pad (link point) to element. pad's parent will be set to element; see gst_object_set_parent() for refcounting information. Pads are not automatically activated so elements should perform the needed steps to activate the pad in case this pad is added in the PAUSED or PLAYING state. See gst_pad_set_active() for more information about activating pads. The pad and the element should be unlocked when calling this function. This function will emit the GstElement::pad-added signal on the element. a pad with the same name already existed or the pad already had another parent. MT safe.

Parameters:

Gst.Pad pad Required (not null)

Returns:

Boolean

Perform transition on element. This function must be called with STATE_LOCK held and is mainly used internally.

Parameters:

Gst.StateChange transition Required (not null)

Returns:

Gst.StateChangeReturn

Commit the state change of the element and proceed to the next pending state if any. This function is used by elements that do asynchronous state changes. The core will normally call this method automatically when an element returned GST_STATE_CHANGE_SUCCESS from the state change function. If after calling this method the element still has not reached the pending state, the next state change is performed. This method is used internally and should normally not be called by plugins or applications. MT safe.

Parameters:

Gst.StateChangeReturn ret Required (not null)

Returns:

Gst.StateChangeReturn

Creates a pad for each pad template that is always available. This function is only useful during object intialization of subclasses of GstElement.

Returns:

none

A default error function. The default handler will simply print the error string using g_print.

Parameters:

Object error Required (not null)

String debug Required (not null)

Returns:

none

If the sink spawns its own thread for pulling buffers from upstream it should call this method after it has pulled a buffer. If the element needed to preroll, this function will perform the preroll and will then block until the element state is changed. This function should be called with the PREROLL_LOCK held. Since 0.10.22 continue. Any other return value should be returned from the render vmethod.

Parameters:

Gst.MiniObject obj Required (not null)

Returns:

Gst.FlowReturn

Posts a message to the bus that new tags were found, and pushes an event to all sourcepads. Takes ownership of the list. This is a utility method for elements. Applications should use the GstTagSetter interface.

Parameters:

Gst.TagList list Required (not null)

Returns:

none

Posts a message to the bus that new tags were found and pushes the tags as event. Takes ownership of the list. This is a utility method for elements. Applications should use the GstTagSetter interface.

Parameters:

Gst.Pad pad Required (not null)

Gst.TagList list Required (not null)

Returns:

none

Returns the base time of the element. The base time is the absolute time of the clock when this element was last put to PLAYING. Subtracting the base time from the clock time gives the running time of the element. MT safe.

Returns:

Number

Get the number of bytes that the sink will pull when it is operating in pull mode.

Returns:

Number

Returns the bus of the element. Note that only a GstPipeline will provide a bus for the application. MT safe.

Returns:

Gst.Bus

Gets the currently configured clock of the element. This is the clock as was last set with gst_element_set_clock(). MT safe.

Returns:

Gst.Clock

Looks for an unlinked pad to which the given pad can link. It is not guaranteed that linking the pads will work, though it should work in most cases. found. gst_object_unref() after usage.

Parameters:

Gst.Pad pad Required (not null)

Gst.Caps caps Required (not null)

Returns:

Gst.Pad

Retrieves a pad template from element that is compatible with compattempl. Pads from compatible templates can be linked together. unreferencing is necessary.

Parameters:

Gst.PadTemplate compattempl Required (not null)

Returns:

Gst.PadTemplate

Retrieves the factory that was used to create this element. no refcounting is needed.

Returns:

Gst.ElementFactory

Gets the index from the element. element. unref after usage. MT safe.

Returns:

Gst.Index

Get the last buffer that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails. The GstCaps on the buffer can be used to determine the type of the buffer. NULL when no buffer has arrived in the sink yet or when the sink is not in PAUSED or PLAYING.

Returns:

Gst.Buffer after usage. This function returns

Get the currently configured latency.

Returns:

Number

Gets the max lateness value. See gst_base_sink_set_max_lateness for more details. before it is dropped and not rendered. A value of -1 means an unlimited time.

Returns:

Number

Returns a copy of the name of object. Caller should g_free() the return value after usage. For a nameless object, this returns NULL, which you can safely g_free() as well. MT safe. This function grabs and releases object's LOCK.

Returns:

String after usage.

Returns a copy of the name prefix of object. Caller should g_free() the return value after usage. For a prefixless object, this returns NULL, which you can safely g_free() as well. MT safe. This function grabs and releases object's LOCK.

Returns:

String after usage.

Retrieves a pad from element by name. Tries gst_element_get_static_pad() first, then gst_element_get_request_pad(). to the result pad should be released with gst_object_unref() in case of a static pad or gst_element_release_request_pad() in case of a request pad. Use gst_element_get_static_pad() or gst_element_get_request_pad() instead. depending on the type of the pad.

Parameters:

String name Required (not null)

Returns:

Gst.Pad

Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. MT safe. Grabs and releases object's LOCK.

Returns:

Gst.Object parent. unref after usage.

Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging. MT safe. Grabs and releases the GstObject's LOCK for all objects in the hierarchy.

Returns:

String g_free() the string after usage.

Get an array of query types from the element. If the element doesn't implement a query types function, the query will be forwarded to the peer of a random linked sink pad. be freed or modified. MT safe.

Returns:

Gst.QueryType

Get the render delay of sink. see gst_base_sink_set_render_delay() for more information about the render delay.

Returns:

Number

Retrieves a pad from the element by name. This version only retrieves request pads. The pad should be released with gst_element_release_request_pad().

Parameters:

String name Required (not null)

Returns:

Gst.Pad

Returns the start time of the element. The start time is the running time of the clock when this element was last put to PAUSED. Usually the start_time is managed by a toplevel element such as GstPipeline. MT safe.

Returns:

Number

Gets the state of the element. For elements that performed an ASYNC state change, as reported by gst_element_set_state(), this function will block up to the specified timeout value for the state change to complete. If the element completes the state change or goes into an error, this function returns immediately with a return value of GST_STATE_CHANGE_SUCCESS or GST_STATE_CHANGE_FAILURE respectively. For elements that did not return GST_STATE_CHANGE_ASYNC, this function returns the current and pending state immediately. This function returns GST_STATE_CHANGE_NO_PREROLL if the element successfully changed its state but is not able to provide data yet. This mostly happens for live sources that only produce data in GST_STATE_PLAYING. While the state change return is equivalent to GST_STATE_CHANGE_SUCCESS, it is returned to the application to signal that some sink elements might not be able to complete their state change because an element is not producing data to complete the preroll. When setting the element to playing, the preroll will complete and playback will start. MT safe.

Parameters:

Object out_values

Gst.State state

Gst.State pending

a pointer to GstState to hold the pending state. Can be NULL.

Gst.State pending Required (not null)

a pointer to GstState to hold the pending state. Can be NULL.

Number timeout Required (not null)

state change or GST_CLOCK_TIME_NONE for infinite timeout.

Returns:

Gst.StateChangeReturn and the last state change succeeded, GST_STATE_CHANGE_ASYNC if the element is still performing a state change or GST_STATE_CHANGE_FAILURE if the last state change failed.

Retrieves a pad from element by name. This version only retrieves already-existing (i.e. 'static') pads. usage. MT safe.

Parameters:

String name Required (not null)

Returns:

Gst.Pad

Checks if sink is currently configured to synchronize against the clock.

Returns:

Boolean

Get the synchronisation offset of sink.

Returns:

Number

Check if object has an ancestor ancestor somewhere up in the hierarchy. MT safe. Grabs and releases object's locks.

Parameters:

Gst.Object ancestor Required (not null)

Returns:

Boolean

Test whether the given element implements a certain interface of type iface_type, and test whether it is supported for this specific instance.

Parameters:

Number iface_type Required (not null)

type of the interface which we want to be implemented

Returns:

Boolean

Checks if sink is currently configured to perform asynchronous state changes to PAUSED. changes.

Returns:

Boolean

Queries if the element can be indexed. MT safe.

Returns:

Boolean

Checks if the state of an element is locked. If the state of an element is locked, state changes of the parent don't affect the element. This way you can leave currently unused elements inside bins. Just lock their state before changing the state from GST_STATE_NULL. MT safe.

Returns:

Boolean

Checks if sink is currently configured to send Quality-of-Service events upstream.

Returns:

Boolean

Retrieves an iterattor of element's pads. The iterator should be freed after usage. MT safe.

Returns:

Gst.Iterator

Retrieves an iterator of element's sink pads. MT safe.

Returns:

Gst.Iterator

Retrieves an iterator of element's source pads. MT safe.

Returns:

Gst.Iterator

Links src to dest. The link must be from source to destination; the other direction will not be tried. The function looks for existing pads that aren't linked yet. It will request new pads if necessary. Such pads need to be released manualy when unlinking. If multiple links are possible, only one is established. Make sure you have added your elements to a bin or pipeline with gst_bin_add() before trying to link them.

Parameters:

Gst.Element dest Required (not null)

Returns:

Boolean

Links src to dest using the given caps as filtercaps. The link must be from source to destination; the other direction will not be tried. The function looks for existing pads that aren't linked yet. It will request new pads if necessary. If multiple links are possible, only one is established. Make sure you have added your elements to a bin or pipeline with gst_bin_add() before trying to link them.

Parameters:

Gst.Element dest Required (not null)

Gst.Caps filter Required (not null)

Returns:

Boolean

or NULL for any pad. Links the two named pads of the source and destination elements. Side effect is that if one of the pads has no parent, it becomes a child of the parent of the other element. If they have different parents, the link fails.

Parameters:

String srcpadname Required (not null)

Gst.Element dest Required (not null)

String destpadname Required (not null)

Returns:

Boolean

Links the two named pads of the source and destination elements. Side effect is that if one of the pads has no parent, it becomes a child of the parent of the other element. If they have different parents, the link fails. If caps is not NULL, makes sure that the caps of the link is a subset of caps.

Parameters:

String srcpadname Required (not null)

Gst.Element dest Required (not null)

String destpadname Required (not null)

Gst.Caps filter Required (not null)

Returns:

Boolean

Brings the element to the lost state. This function calls gst_element_lost_state_full() with the new_base_time set to TRUE. This function is used internally and should normally not be called from plugins or applications. MT safe.

Returns:

none

Brings the element to the lost state. The current state of the element is copied to the pending state so that any call to gst_element_get_state() will return GST_STATE_CHANGE_ASYNC. An ASYNC_START message is posted with indication to distribute a new base_time to the element when new_base_time is TRUE. If the element was PLAYING, it will go to PAUSED. The element will be restored to its PLAYING state by the parent pipeline when it prerolls again. This is mostly used for elements that lost their preroll buffer in the GST_STATE_PAUSED or GST_STATE_PLAYING state after a flush, they will go to their pending state again when a new preroll buffer is queued. This function can only be called when the element is currently not in error or an async state change. This function is used internally and should normally not be called from plugins or applications. MT safe.

Parameters:

Boolean new_base_time Required (not null)

Returns:

none

Post an error, warning or info message on the bus from inside an element. GST_MESSAGE_INFO. MT safe.

Parameters:

Gst.MessageType type Required (not null)

Number domain Required (not null)

Number code Required (not null)

String text Required (not null)

default message connected to code, or NULL

String debug Required (not null)

default debugging information, or NULL

String file Required (not null)

String function Required (not null)

Number line Required (not null)

Returns:

none

Use this function to signal that the element does not expect any more pads to show up in the current pipeline. This function should be called whenever pads have been added by the element itself. Elements with GST_PAD_SOMETIMES pad templates use this in combination with autopluggers to figure out that the element is done initializing its pads. This function emits the GstElement::no-more-pads signal. MT safe.

Returns:

none

Post a message on the element's GstBus. This function takes ownership of the message; if you want to access the message after this call, you should add an additional reference before calling. FALSE if the element did not have a bus. MT safe.

Parameters:

Gst.Message message Required (not null)

Returns:

Boolean

Get the clock provided by the given element. An element is only required to provide a clock in the PAUSED state. Some elements can provide a clock in other states. if no clock could be provided. Unref after usage. MT safe.

Returns:

Gst.Clock

Query if the element provides a clock. A GstClock provided by an element can be used as the global GstClock for the pipeline. An element that can provide a clock is only required to do so in the PAUSED state, this means when it is fully negotiated and has allocated the resources to operate the clock. MT safe.

Returns:

Boolean

Performs a query on the given element. For elements that don't implement a query handler, this function forwards the query to a random srcpad or to the peer of a random linked sinkpad of this element. MT safe.

Parameters:

Gst.Query query Required (not null)

Returns:

Boolean

Queries an element to convert src_val in src_format to dest_format.

Parameters:

Gst.Format src_format Required (not null)

Number src_val Required (not null)

Gst.Format dest_format Required (not null)

Object out_values

Number dest_val

Returns:

Boolean

Queries an element for the total stream duration.

Parameters:

Gst.Format format Required (not null)

a pointer to the GstFormat asked for. On return contains the GstFormat used.

Object out_values

Number duration

Returns:

Boolean

Query the sink for the latency parameters. The latency will be queried from the upstream elements. live will be TRUE if sink is configured to synchronize against the clock. upstream_live will be TRUE if an upstream element is live. If both live and upstream_live are TRUE, the sink will want to compensate for the latency introduced by the upstream elements by setting the This function is mostly used by subclasses.

Parameters:

Object out_values

Boolean live

Boolean upstream_live

Boolean upstream_live Required (not null)

Number min_latency Required (not null)

Number max_latency Required (not null)

Returns:

Boolean

Queries an element for the stream position.

Parameters:

Gst.Format format Required (not null)

On return contains the GstFormat used.

Object out_values

Number cur

Returns:

Boolean

Makes the element free the previously requested pad as obtained with gst_element_get_request_pad(). This does not unref the pad. If the pad was created by using gst_element_get_request_pad(), gst_element_release_request_pad() needs to be followed by gst_object_unref() to free the pad. MT safe.

Parameters:

Gst.Pad pad Required (not null)

Returns:

none

Removes pad from element. pad will be destroyed if it has not been referenced elsewhere using gst_object_unparent(). This function is used by plugin developers and should not be used by applications. Pads that were dynamically requested from elements with gst_element_get_request_pad() should be released with the gst_element_release_request_pad() function instead. Pads are not automatically deactivated so elements should perform the needed steps to deactivate the pad in case this pad is removed in the PAUSED or PLAYING state. See gst_pad_set_active() for more information about deactivating pads. The pad and the element should be unlocked when calling this function. This function will emit the GstElement::pad-removed signal on the element. pad does not belong to the provided element. MT safe.

Parameters:

Gst.Pad pad Required (not null)

Returns:

Boolean

Unrefs the GstObject pointed to by oldobj, refs newobj and puts newobj in *oldobj. Be carefull when calling this function, it does not take any locks. You might want to lock the object owning oldobj pointer before calling this function. Make sure not to LOCK oldobj because it might be unreffed which could cause a deadlock when it is disposed.

Parameters:

Gst.Object newobj Required (not null)

Returns:

none

Query if the element requires a clock. MT safe.

Returns:

Boolean

Restores object with the data from the parent XML node.

Parameters:

libxml2.Node self Required (not null)

Returns:

none

Saves object into the parent XML node.

Parameters:

libxml2.Node parent Required (not null)

Returns:

libxml2.Node

Sends a seek event to an element. See gst_event_new_seek() for the details of the parameters. The seek event is sent to the element using gst_element_send_event(). MT safe.

Parameters:

Number rate Required (not null)

Gst.Format format Required (not null)

Gst.SeekFlags flags Required (not null)

Gst.SeekType cur_type Required (not null)

Number cur Required (not null)

Gst.SeekType stop_type Required (not null)

Number stop Required (not null)

Returns:

Boolean

Parameters:

Gst.Format format Required (not null)

Gst.SeekFlags seek_flags Required (not null)

Number seek_pos Required (not null)

Returns:

Boolean

Sends an event to an element. If the element doesn't implement an event handler, the event will be pushed on a random linked sink pad for upstream events or a random linked source pad for downstream events. This function takes owership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call. MT safe.

Parameters:

Gst.Event event Required (not null)

Returns:

Boolean

Configures sink to perform all state changes asynchronusly. When async is disabled, the sink will immediatly go to PAUSED instead of waiting for a preroll buffer. This feature is usefull if the sink does not synchronize against the clock or when it is dealing with sparse streams.

Parameters:

Boolean enabled Required (not null)

Returns:

none

Set the base time of an element. See gst_element_get_base_time(). MT safe.

Parameters:

Number time Required (not null)

Returns:

none

Set the number of bytes that the sink will pull when it is operating in pull mode.

Parameters:

Number blocksize Required (not null)

Returns:

none

Sets the bus of the element. Increases the refcount on the bus. For internal use only, unless you're testing elements. MT safe.

Parameters:

Gst.Bus bus Required (not null)

Returns:

none

Sets the clock for the element. This function increases the refcount on the clock. Any previously set clock on the object is unreffed. clock when it, for example, is not able to slave its internal clock to the MT safe.

Parameters:

Gst.Clock clock Required (not null)

Returns:

Boolean

Set index on the element. The refcount of the index will be increased, any previously set index is unreffed. MT safe.

Parameters:

Gst.Index index Required (not null)

Returns:

none

Locks the state of an element, so state changes of the parent don't affect this element anymore. MT safe. or the elements state-locking needed no change.

Parameters:

Boolean locked_state Required (not null)

Returns:

Boolean

Sets the new max lateness value to max_lateness. This value is used to decide if a buffer should be dropped or not based on the buffer timestamp and the current clock time. A value of -1 means an unlimited time.

Parameters:

Number max_lateness Required (not null)

Returns:

none

Sets the name of object, or gives object a guaranteed unique name (if name is NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent. a parent cannot be renamed, this function returns FALSE in those cases. MT safe. This function grabs and releases object's LOCK.

Parameters:

String name Required (not null)

Returns:

Boolean

Sets the name prefix of object to name_prefix. This function makes a copy of the provided name prefix, so the caller retains ownership of the name prefix it sent. MT safe. This function grabs and releases object's LOCK.

Parameters:

String name_prefix Required (not null)

Returns:

none

Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_sink()). This function causes the parent-set signal to be emitted when the parent was successfully set. already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK.

Parameters:

Gst.Object parent Required (not null)

Returns:

Boolean

Configures sink to send Quality-of-Service events upstream.

Parameters:

Boolean enabled Required (not null)

Returns:

none

Set the render delay in sink to delay. The render delay is the time between actual rendering of a buffer and its synchronisation time. Some devices might delay media rendering which can be compensated for with this function. After calling this function, this sink will report additional latency and other sinks will adjust their latency to delay the rendering of their media. This function is usually called by subclasses.

Parameters:

Number delay Required (not null)

Returns:

none

Set the start time of an element. The start time of the element is the running time of the element when it last went to the PAUSED state. In READY or after a flushing seek, it is set to 0. Toplevel elements like GstPipeline will manage the start_time and base_time on its children. Setting the start_time to GST_CLOCK_TIME_NONE on such a toplevel element will disable the distribution of the base_time to the children and can be useful if the application manages the base_time itself, for example if you want to synchronize capture from multiple pipelines, and you can also ensure that the pipelines have the same clock. MT safe.

Parameters:

Number time Required (not null)

Returns:

none

Sets the state of the element. This function will try to set the requested state by going through all the intermediary states and calling the class's state change function for each. This function can return GST_STATE_CHANGE_ASYNC, in which case the element will perform the remainder of the state change asynchronously in another thread. An application can use gst_element_get_state() to wait for the completion of the state change or it can wait for a state change message on the bus. State changes to GST_STATE_READY or GST_STATE_NULL never return GST_STATE_CHANGE_ASYNC. MT safe.

Parameters:

Gst.State state Required (not null)

Returns:

Gst.StateChangeReturn

Configures sink to synchronize on the clock or not. When possible. If sync is TRUE, the timestamps of the incomming buffers will be used to schedule the exact render time of its contents.

Parameters:

Boolean sync Required (not null)

Returns:

none

Adjust the synchronisation of sink with offset. A negative value will render buffers earlier than their timestamp. A positive value will delay rendering. This function can be used to fix playback of badly timestamped buffers.

Parameters:

Number offset Required (not null)

Returns:

none

Tries to change the state of the element to the same as its parent. If this function returns FALSE, the state of element is undefined. MT safe.

Returns:

Boolean

Unlinks all source pads of the source element with all sink pads of the sink element to which they are linked. If the link has been made using gst_element_link(), it could have created an requestpad, which has to be released using gst_element_release_request_pad().

Parameters:

Gst.Element dest Required (not null)

Returns:

none

Unlinks the two named pads of the source and destination elements.

Parameters:

String srcpadname Required (not null)

Gst.Element dest Required (not null)

String destpadname Required (not null)

Returns:

none

Clear the parent of object, removing the associated reference. This function decreases the refcount of object. MT safe. Grabs and releases object's lock.

Returns:

none

This function will block until time is reached. It is usually called by subclasses that use their own internal synchronisation. If time is not valid, no sycnhronisation is done and GST_CLOCK_BADTIME is returned. Likewise, if synchronisation is disabled in the element or there is no clock, no synchronisation is done and GST_CLOCK_BADTIME is returned. This function should only be called with the PREROLL_LOCK held, like when receiving an EOS event in the GstBaseSinkClass.event() vmethod or when receiving a buffer in the GstBaseSinkClass.render() vmethod. The time argument should be the running_time of when this method should return and is not adjusted with any latency or offset configured in the sink. Since 0.10.20

Parameters:

Number time Required (not null)

Number jitter Required (not null)

Returns:

Gst.ClockReturn

This function will block until time is reached. It is usually called by subclasses that use their own internal synchronisation but want to let the EOS be handled by the base class. This function should only be called with the PREROLL_LOCK held, like when receiving an EOS event in the ::event vmethod. The time argument should be the running_time of when the EOS should happen and will be adjusted with any latency and offset configured in the sink. Since 0.10.15

Parameters:

Number time Required (not null)

Number jitter Required (not null)

Returns:

Gst.FlowReturn

If the GstBaseSinkClass.render() 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 render the remaining data. This function will block until a state change to PLAYING happens (in which case this function returns GST_FLOW_OK) or the processing must be stopped due to a state change to READY or a FLUSH event (in which case this function returns GST_FLOW_WRONG_STATE). This function should only be called with the PREROLL_LOCK held, like in the render function. continue. Any other return value should be returned from the render vmethod.

Returns:

Gst.FlowReturn

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

Parameters:

Gst.Object self

Gst.Object prop_object

GObject.ParamSpec prop

Returns:

{none}

This signals that the element will not generate more dynamic pads.

Parameters:

Gst.Element self

Returns:

{none}

Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML.

Parameters:

Gst.Object self

void* xml_node

Returns:

{none}

a new GstPad has been added to the element.

Parameters:

Gst.Element self

Gst.Pad new_pad

Returns:

{none}

a GstPad has been removed from the element

Parameters:

Gst.Element self

Gst.Pad old_pad

Returns:

{none}

Emitted when the parent of an object is set.

Parameters:

Gst.Object self

Gst.Object parent

Returns:

{none}

Emitted when the parent of an object is unset.

Parameters:

Gst.Object self

Gst.Object parent

Returns:

{none}