Creates a new pad with the given name in the given direction. If name is null, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.
Activates or deactivates the given pad in mode via dispatching to the pad's activatemodefunc. For use from within pad activation functions only.
Be notified of different states of pads. The provided callback is called for every state that matches mask.
Checks if the source pad and the sink pad are compatible so they can be linked.
Chain a buffer to pad.
Chain a bufferlist to pad.
Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on pad and return true if the flag was set.
Connect to Linked signal.
Connect to Unlinked signal.
Creates a stream-id for the source #GstPad pad by combining the upstream information with the optional stream_id of the stream of pad. pad must have a parent #GstElement and which must have zero or one sinkpad. stream_id can only be null if the parent element of pad has only a single source pad.
Invokes the default event handler for the given pad.
Calls forward for all internally linked pads of pad. This function deals with dynamically changing internal pads and will make sure that the forward function is only called once for each pad.
Gets the capabilities of the allowed media types that can flow through pad and its peer.
Gets the capabilities currently configured on pad with the last #GST_EVENT_CAPS event.
Gets the direction of the pad. The direction of the pad is decided at construction time so this function does not take the LOCK.
Gets the private data of a pad. No locking is performed in this function.
Gets the #GstFlowReturn return from the last data passed by this pad.
Get the offset applied to the running time of pad. pad has to be a source pad.
Gets the template for pad.
Gets the capabilities for pad's template.
Gets the parent of pad, cast to a #GstElement. If a pad has no parent or its parent is not an element, return null.
Gets the peer of pad. This function refs the peer pad so you need to unref it after use.
When pad is flushing this function returns #GST_FLOW_FLUSHING immediately and buffer is null.
If there is a single internal link of the given pad, this function will return it. Otherwise, it will return NULL.
Returns a new reference of the sticky event of type event_type from the event.
Returns the current #GstStream for the pad, or null if none has been set yet, i.e. the pad has not received a stream-start event yet.
Returns the current stream-id for the pad, or null if none has been set yet, i.e. the pad has not received a stream-start event yet.
Get pad task state. If no task is currently set, #GST_TASK_STOPPED is returned.
Check if pad has caps set on it with a #GST_EVENT_CAPS event.
Query if a pad is active
Checks if the pad is blocked or not. This function returns the last requested state of the pad. It is not certain that the pad is actually blocking at this point (see gst.pad.Pad.isBlocking).
Checks if the pad is blocking or not. This is a guaranteed state of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
Checks if a pad is linked to another pad or not.
Gets an iterator for the pads to which the given pad is linked to inside of the parent element.
Iterate the list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns an iterator of all of the pads inside the parent element with opposite direction.
Links the source pad and the sink pad.
Links the source pad and the sink pad.
Links src to sink, creating any #GstGhostPad's in between as necessary.
Links src to sink, creating any #GstGhostPad's in between as necessary.
Mark a pad for needing reconfiguration. The next call to gst.pad.Pad.checkReconfigure will return true after this call.
Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on pad and return true if the flag was set.
Pause the task of pad. This function will also wait until the function executed by the task is finished if this function is not called from the task function.
Performs gst.pad.Pad.query on the peer of pad.
Check if the peer of pad accepts caps. If pad has no peer, this function returns true.
Gets the capabilities of the peer connected to this pad. Similar to gst.pad.Pad.queryCaps.
Queries the peer pad of a given sink pad to convert src_val in src_format to dest_format.
Queries the peer pad of a given sink pad for the total stream duration.
Queries the peer of a given sink pad for the stream position.
Checks if all internally linked pads of pad accepts the caps in query and returns the intersection of the results.
Calls gst.pad.Pad.queryCaps for all internally linked pads of pad and returns the intersection of the results.
Pulls a buffer from the peer pad or fills up a provided buffer.
Pushes a buffer to the peer of pad.
Sends the event to the peer of the given pad. This function is mainly used by elements to send events to their peer elements.
Pushes a buffer list to the peer of pad.
Dispatches a query to a pad. The query should have been allocated by the caller via one of the type-specific allocation functions. The element that the pad belongs to is responsible for filling the query with an appropriate response, which should then be parsed with a type-specific query parsing function.
Check if the given pad accepts the caps.
Gets the capabilities this pad can produce or consume. Note that this method doesn't necessarily return the caps set by sending a gst.event.Event.newCaps - use gst.pad.Pad.getCurrentCaps for that instead. gst_pad_query_caps returns all possible caps a pad can operate with, using the pad's CAPS query function, If the query fails, this function will return filter, if not null, otherwise ANY.
Queries a pad to convert src_val in src_format to dest_format.
Invokes the default query handler for the given pad. The query is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to pad, only one will be sent the query. Multi-sinkpad elements should implement custom query handlers.
Queries a pad for the total stream duration.
Queries a pad for the stream position.
Remove the probe with id from pad.
Sends the event to the pad. This function can be used by applications to send events in the pipeline.
Activates or deactivates the given pad. Normally called from within core state change functions.
Set the given private data gpointer on the pad. This function can only be used by the element that owns the pad. No locking is performed in this function.
Set the offset that will be applied to the running time of pad.
Starts a task that repeatedly calls func with user_data. This function is mostly used in pad activation functions to start the dataflow. The #GST_PAD_STREAM_LOCK of pad will automatically be acquired before func is called.
Iterates all sticky events on pad and calls foreach_func for every event. If foreach_func returns false the iteration is immediately stopped.
Stop the task of pad. This function will also make sure that the function executed by the task will effectively stop if not called from the GstTaskFunction.
Store the sticky event on pad
Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked signal on both pads.
A helper function you can use that sets the FIXED_CAPS flag This way the default CAPS query will always return the negotiated caps or in case the pad is not negotiated, the padtemplate caps.
Gets a string representing the given pad-link return.
Creates a new pad with the given name from the given static template. If name is null, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.
Creates a new pad with the given name from the given template. If name is null, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.
Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object.
A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.
Atomically modifies a pointer to point to a new object. The reference count of oldobj is decreased and the reference count of newobj is increased.
Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.
A default error function that uses glib.global.printerr to display the error message and the optional debug string..
Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.
Obtain the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.
Returns a copy of the name of object. Caller should glib.global.gfree the return value after usage. For a nameless object, this returns null, which you can safely glib.global.gfree as well.
Returns the parent of object. This function increases the refcount of the parent object so you should gst.object.ObjectGst.unref it after usage.
Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.
Gets the value for the given controlled property at the requested time.
Check if the object has active controlled properties.
Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
Check if parent is the parent of object. E.g. a #GstElement can check if it owns a given #GstPad.
Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed.
This function is used to disable the control bindings on a property for some time, i.e. gst.object.ObjectGst.syncValues will do nothing for the property.
This function is used to disable all controlled properties of the object for some time, i.e. gst.object.ObjectGst.syncValues will do nothing.
Change the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
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.
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.ObjectGst.refSink).
Returns a suggestion for timestamps where buffers should be split to get best controller results.
Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.
Clear the parent of object, removing the associated reference. This function decreases the refcount of object.
Connect to DeepNotify signal.
A #GstElement is linked to other elements via "pads", which are extremely light-weight generic link points.
Pads have a #GstPadDirection, source pads produce data, sink pads consume data.
Pads are typically created from a #GstPadTemplate with gst.pad.Pad.newFromTemplate and are then added to a #GstElement. This usually happens when the element is created but it can also happen dynamically based on the data that the element is processing or based on the pads that the application requests.
Pads without pad templates can be created with gst.pad.Pad.new_, which takes a direction and a name as an argument. If the name is null, then a guaranteed unique name will be assigned to it.
A #GstElement creating a pad will typically use the various gst_pad_set_*_function\() calls to register callbacks for events, queries or dataflow on the pads.
gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
After two pads are retrieved from an element by gst.element.Element.getStaticPad, the pads can be linked with gst.pad.Pad.link. (For quick links, you can also use gst.element.Element.link, which will make the obvious link for you if it's straightforward.). Pads can be unlinked again with gst.pad.Pad.unlink. gst.pad.Pad.getPeer can be used to check what the pad is linked to.
Before dataflow is possible on the pads, they need to be activated with gst.pad.Pad.setActive.
gst.pad.Pad.query and gst.pad.Pad.peerQuery can be used to query various properties of the pad and the stream.
To send a #GstEvent on a pad, use gst.pad.Pad.sendEvent and gst.pad.Pad.pushEvent. Some events will be sticky on the pad, meaning that after they pass on the pad they can be queried later with gst.pad.Pad.getStickyEvent and gst.pad.Pad.stickyEventsForeach. gst.pad.Pad.getCurrentCaps and gst.pad.Pad.hasCurrentCaps are convenience functions to query the current sticky CAPS event on a pad.
GstElements will use gst.pad.Pad.push and gst.pad.Pad.pullRange to push out or pull in a buffer.
The dataflow, events and queries that happen on a pad can be monitored with probes that can be installed with gst.pad.Pad.addProbe. gst.pad.Pad.isBlocked can be used to check if a block probe is installed on the pad. gst.pad.Pad.isBlocking checks if the blocking probe is currently blocking the pad. gst.pad.Pad.removeProbe is used to remove a previously installed probe and unblock blocking probes if any.
Pad have an offset that can be retrieved with gst.pad.Pad.getOffset. This offset will be applied to the running_time of all data passing over the pad. gst.pad.Pad.setOffset can be used to change the offset.
Convenience functions exist to start, pause and stop the task on a pad with gst.pad.Pad.startTask, gst.pad.Pad.pauseTask and gst.pad.Pad.stopTask respectively.