CollectPads

Manages a set of pads that operate in collect mode. This means that control is given to the manager of this object when all pads have data.

Constructors

this
this()

Create a new instance of #GstCollectPads.

Members

Functions

available
uint available()

Query how much bytes can be read from each queued buffer. This means that the result of this call is the maximum number of bytes that can be read from each of the pads.

clipRunningTime
gst.types.FlowReturn clipRunningTime(gstbase.collect_data.CollectData cdata, gst.buffer.Buffer buf, gst.buffer.Buffer outbuf, void* userData)

Convenience clipping function that converts incoming buffer's timestamp to running time, or clips the buffer if outside configured segment.

eventDefault
bool eventDefault(gstbase.collect_data.CollectData data, gst.event.Event event, bool discard)

Default #GstCollectPads event handling that elements should always chain up to to ensure proper operation. Element might however indicate event should not be forwarded downstream.

flush
uint flush(gstbase.collect_data.CollectData data, uint size)

Flush size bytes from the pad data.

peek
gst.buffer.Buffer peek(gstbase.collect_data.CollectData data)

Peek at the buffer currently queued in data. This function should be called with the pads STREAM_LOCK held, such as in the callback handler.

pop
gst.buffer.Buffer pop(gstbase.collect_data.CollectData data)

Pop the buffer currently queued in data. This function should be called with the pads STREAM_LOCK held, such as in the callback handler.

queryDefault
bool queryDefault(gstbase.collect_data.CollectData data, gst.query.Query query, bool discard)

Default #GstCollectPads query handling that elements should always chain up to to ensure proper operation. Element might however indicate query should not be forwarded downstream.

readBuffer
gst.buffer.Buffer readBuffer(gstbase.collect_data.CollectData data, uint size)

Get a subbuffer of size bytes from the given pad data.

removePad
bool removePad(gst.pad.Pad pad)

Remove a pad from the collection of collect pads. This function will also free the #GstCollectData and all the resources that were allocated with gstbase.collect_pads.CollectPads.addPad.

setBufferFunction
void setBufferFunction(gstbase.types.CollectPadsBufferFunction func)

Set the callback function and user data that will be called with the oldest buffer when all pads have been collected, or null on EOS. If a buffer is passed, the callback owns a reference and must unref it.

setClipFunction
void setClipFunction(gstbase.types.CollectPadsClipFunction clipfunc)

Install a clipping function that is called right after a buffer is received on a pad managed by pads. See #GstCollectPadsClipFunction for more info.

setCompareFunction
void setCompareFunction(gstbase.types.CollectPadsCompareFunction func)

Set the timestamp comparison function.

setEventFunction
void setEventFunction(gstbase.types.CollectPadsEventFunction func)

Set the event callback function and user data that will be called when collectpads has received an event originating from one of the collected pads. If the event being processed is a serialized one, this callback is called with pads STREAM_LOCK held, otherwise not. As this lock should be held when calling a number of CollectPads functions, it should be acquired if so (unusually) needed.

setFlushFunction
void setFlushFunction(gstbase.types.CollectPadsFlushFunction func)

Install a flush function that is called when the internal state of all pads should be flushed as part of flushing seek handling. See #GstCollectPadsFlushFunction for more info.

setFlushing
void setFlushing(bool flushing)

Change the flushing state of all the pads in the collection. No pad is able to accept anymore data when flushing is true. Calling this function with flushing false makes pads accept data again. Caller must ensure that downstream streaming (thread) is not blocked, e.g. by sending a FLUSH_START downstream.

setFunction
void setFunction(gstbase.types.CollectPadsFunction func)

CollectPads provides a default collection algorithm that will determine the oldest buffer available on all of its pads, and then delegate to a configured callback. However, if circumstances are more complicated and/or more control is desired, this sets a callback that will be invoked instead when all the pads added to the collection have buffers queued. Evidently, this callback is not compatible with gstbase.collect_pads.CollectPads.setBufferFunction callback. If this callback is set, the former will be unset.

setQueryFunction
void setQueryFunction(gstbase.types.CollectPadsQueryFunction func)

Set the query callback function and user data that will be called after collectpads has received a query originating from one of the collected pads. If the query being processed is a serialized one, this callback is called with pads STREAM_LOCK held, otherwise not. As this lock should be held when calling a number of CollectPads functions, it should be acquired if so (unusually) needed.

setWaiting
void setWaiting(gstbase.collect_data.CollectData data, bool waiting)

Sets a pad to waiting or non-waiting mode, if at least this pad has not been created with locked waiting state, in which case nothing happens.

srcEventDefault
bool srcEventDefault(gst.pad.Pad pad, gst.event.Event event)

Default #GstCollectPads event handling for the src pad of elements. Elements can chain up to this to let flushing seek event handling be done by #GstCollectPads.

start
void start()

Starts the processing of data in the collect_pads.

stop
void stop()

Stops the processing of data in the collect_pads. this function will also unblock any blocking operations.

takeBuffer
gst.buffer.Buffer takeBuffer(gstbase.collect_data.CollectData data, uint size)

Get a subbuffer of size bytes from the given pad data. Flushes the amount of read bytes.

Inherited Members

From ObjectGst

checkUniqueness
bool checkUniqueness(gst.object.ObjectGst[] list, string 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.

defaultDeepNotify
void defaultDeepNotify(gobject.object.ObjectG object, gst.object.ObjectGst orig, gobject.param_spec.ParamSpec pspec, string[] excludedProps)

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.

replace
bool replace(gst.object.ObjectGst oldobj, gst.object.ObjectGst newobj)

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.

addControlBinding
bool addControlBinding(gst.control_binding.ControlBinding binding)

Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.

defaultError
void defaultError(glib.error.ErrorG error, string debug_)

A default error function that uses glib.global.printerr to display the error message and the optional debug string..

getControlBinding
gst.control_binding.ControlBinding getControlBinding(string propertyName)

Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.

getControlRate
gst.types.ClockTime getControlRate()

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.

getGValueArray
bool getGValueArray(string propertyName, gst.types.ClockTime timestamp, gst.types.ClockTime interval, gobject.value.Value[] values)

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.

getName
string getName()

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.

getParent
gst.object.ObjectGst getParent()

Returns the parent of object. This function increases the refcount of the parent object so you should gst.object.ObjectGst.unref it after usage.

getPathString
string getPathString()

Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.

getValue
gobject.value.Value getValue(string propertyName, gst.types.ClockTime timestamp)

Gets the value for the given controlled property at the requested time.

hasActiveControlBindings
bool hasActiveControlBindings()

Check if the object has active controlled properties.

hasAncestor
bool hasAncestor(gst.object.ObjectGst ancestor)

Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.

hasAsAncestor
bool hasAsAncestor(gst.object.ObjectGst ancestor)

Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.

hasAsParent
bool hasAsParent(gst.object.ObjectGst parent)

Check if parent is the parent of object. E.g. a #GstElement can check if it owns a given #GstPad.

removeControlBinding
bool removeControlBinding(gst.control_binding.ControlBinding binding)

Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed.

setControlBindingDisabled
void setControlBindingDisabled(string propertyName, bool disabled)

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.

setControlBindingsDisabled
void setControlBindingsDisabled(bool disabled)

This function is used to disable all controlled properties of the object for some time, i.e. gst.object.ObjectGst.syncValues will do nothing.

setControlRate
void setControlRate(gst.types.ClockTime controlRate)

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.

setName
bool setName(string name)

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.

setParent
bool setParent(gst.object.ObjectGst parent)

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).

suggestNextSync
gst.types.ClockTime suggestNextSync()

Returns a suggestion for timestamps where buffers should be split to get best controller results.

syncValues
bool syncValues(gst.types.ClockTime timestamp)

Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.

unparent
void unparent()

Clear the parent of object, removing the associated reference. This function decreases the refcount of object.

connectDeepNotify
ulong connectDeepNotify(string detail, T callback, Flag!"After" after)

Connect to DeepNotify signal.