mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-04-10 10:04:23 +00:00
docs: fix up some Since markers and update for new multiqueue args
This commit is contained in:
Tim-Philipp Müller
parent
7316a88387
commit
76ccd2a1e9
7 changed files with 48 additions and 28 deletions
|
|
@ -848,6 +848,16 @@
|
|||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstMultiQueue::sync-by-running-time</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Sync By Running Time</NICK>
|
||||
<BLURB>Synchronize deactivated or not-linked streams by running time.</BLURB>
|
||||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstBin::async-handling</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
|
|
@ -1068,3 +1078,13 @@
|
|||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstInputSelector::sync-streams</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Sync Streams</NICK>
|
||||
<BLURB>Synchronize inactive streams to the running time of the active stream.</BLURB>
|
||||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
|
|
|
|||
|
|
@ -602,7 +602,7 @@ struct _GstElement
|
|||
* @get_query_types: get the supported #GstQueryType of this element
|
||||
* @query: perform a #GstQuery on the element
|
||||
* @request_new_pad_full: called when a new pad is requested. Since: 0.10.32.
|
||||
* @state_changed: called immediately after a new state was set. Since: 0.10.34.
|
||||
* @state_changed: called immediately after a new state was set. Since: 0.10.35.
|
||||
*
|
||||
* GStreamer element class. Override the vmethods to implement the element
|
||||
* functionality.
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ static GParamSpec *pspec_caps = NULL;
|
|||
* Returns: (transfer none) (array zero-terminated=1): a zero-terminated array
|
||||
* of #GstQueryType.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
const GstQueryType *
|
||||
gst_proxy_pad_query_type_default (GstPad * pad)
|
||||
|
|
@ -126,7 +126,7 @@ gst_proxy_pad_query_type_default (GstPad * pad)
|
|||
*
|
||||
* Returns: TRUE if the event was handled.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_proxy_pad_event_default (GstPad * pad, GstEvent * event)
|
||||
|
|
@ -156,7 +156,7 @@ gst_proxy_pad_event_default (GstPad * pad, GstEvent * event)
|
|||
*
|
||||
* Returns: TRUE if the query could be performed.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_proxy_pad_query_default (GstPad * pad, GstQuery * query)
|
||||
|
|
@ -185,7 +185,7 @@ gst_proxy_pad_query_default (GstPad * pad, GstQuery * query)
|
|||
* Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
|
||||
* returned pad with gst_object_unref().
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstIterator *
|
||||
gst_proxy_pad_iterate_internal_links_default (GstPad * pad)
|
||||
|
|
@ -224,7 +224,7 @@ gst_proxy_pad_iterate_internal_links_default (GstPad * pad)
|
|||
* An error can occur if the pad is not connected or when the downstream
|
||||
* peer elements cannot provide an acceptable buffer.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstFlowReturn
|
||||
gst_proxy_pad_bufferalloc_default (GstPad * pad, guint64 offset, guint size,
|
||||
|
|
@ -257,7 +257,7 @@ gst_proxy_pad_bufferalloc_default (GstPad * pad, guint64 offset, guint size,
|
|||
*
|
||||
* Returns: a #GstFlowReturn from the pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstFlowReturn
|
||||
gst_proxy_pad_chain_default (GstPad * pad, GstBuffer * buffer)
|
||||
|
|
@ -284,7 +284,7 @@ gst_proxy_pad_chain_default (GstPad * pad, GstBuffer * buffer)
|
|||
*
|
||||
* Returns: a #GstFlowReturn from the pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstFlowReturn
|
||||
gst_proxy_pad_chain_list_default (GstPad * pad, GstBufferList * list)
|
||||
|
|
@ -313,7 +313,7 @@ gst_proxy_pad_chain_list_default (GstPad * pad, GstBufferList * list)
|
|||
*
|
||||
* Returns: a #GstFlowReturn from the pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstFlowReturn
|
||||
gst_proxy_pad_getrange_default (GstPad * pad, guint64 offset, guint size,
|
||||
|
|
@ -339,7 +339,7 @@ gst_proxy_pad_getrange_default (GstPad * pad, guint64 offset, guint size,
|
|||
*
|
||||
* Returns: a #gboolean from the pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_proxy_pad_checkgetrange_default (GstPad * pad)
|
||||
|
|
@ -363,7 +363,7 @@ gst_proxy_pad_checkgetrange_default (GstPad * pad)
|
|||
*
|
||||
* Returns: (transfer full): the caps of the pad with incremented ref-count
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstCaps *
|
||||
gst_proxy_pad_getcaps_default (GstPad * pad)
|
||||
|
|
@ -427,7 +427,7 @@ done:
|
|||
*
|
||||
* Returns: TRUE if the pad can accept the caps.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_proxy_pad_acceptcaps_default (GstPad * pad, GstCaps * caps)
|
||||
|
|
@ -458,7 +458,7 @@ gst_proxy_pad_acceptcaps_default (GstPad * pad, GstCaps * caps)
|
|||
*
|
||||
* Invoke the default fixatecaps function of the proxy pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
void
|
||||
gst_proxy_pad_fixatecaps_default (GstPad * pad, GstCaps * caps)
|
||||
|
|
@ -485,7 +485,7 @@ gst_proxy_pad_fixatecaps_default (GstPad * pad, GstCaps * caps)
|
|||
* Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
|
||||
* or bad parameters were provided to this function.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_proxy_pad_setcaps_default (GstPad * pad, GstCaps * caps)
|
||||
|
|
@ -582,7 +582,7 @@ gst_proxy_pad_get_target (GstPad * pad)
|
|||
* Returns: (transfer full): the target #GstProxyPad, can be NULL.
|
||||
* Unref target pad after usage.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstProxyPad *
|
||||
gst_proxy_pad_get_internal (GstProxyPad * pad)
|
||||
|
|
@ -606,7 +606,7 @@ gst_proxy_pad_get_internal (GstProxyPad * pad)
|
|||
*
|
||||
* Invoke the default unlink function of the proxy pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
void
|
||||
gst_proxy_pad_unlink_default (GstPad * pad)
|
||||
|
|
@ -798,7 +798,7 @@ static void gst_ghost_pad_dispose (GObject * object);
|
|||
*
|
||||
* Returns: %TRUE if the operation was successful.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_ghost_pad_internal_activate_push_default (GstPad * pad, gboolean active)
|
||||
|
|
@ -829,7 +829,7 @@ gst_ghost_pad_internal_activate_push_default (GstPad * pad, gboolean active)
|
|||
*
|
||||
* Returns: %TRUE if the operation was successful.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_ghost_pad_internal_activate_pull_default (GstPad * pad, gboolean active)
|
||||
|
|
@ -875,7 +875,7 @@ gst_ghost_pad_internal_activate_pull_default (GstPad * pad, gboolean active)
|
|||
*
|
||||
* Returns: %TRUE if the operation was successful.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_ghost_pad_activate_push_default (GstPad * pad, gboolean active)
|
||||
|
|
@ -904,7 +904,7 @@ gst_ghost_pad_activate_push_default (GstPad * pad, gboolean active)
|
|||
*
|
||||
* Returns: %TRUE if the operation was successful.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_ghost_pad_activate_pull_default (GstPad * pad, gboolean active)
|
||||
|
|
@ -948,7 +948,7 @@ gst_ghost_pad_activate_pull_default (GstPad * pad, gboolean active)
|
|||
*
|
||||
* Returns: #GstPadLinkReturn of the operation
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
GstPadLinkReturn
|
||||
gst_ghost_pad_link_default (GstPad * pad, GstPad * peer)
|
||||
|
|
@ -998,7 +998,7 @@ link_failed:
|
|||
*
|
||||
* Invoke the default unlink function of a ghost pad.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
void
|
||||
gst_ghost_pad_unlink_default (GstPad * pad)
|
||||
|
|
@ -1108,7 +1108,7 @@ done:
|
|||
*
|
||||
* Returns: %TRUE if the operation was successful
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
gboolean
|
||||
gst_ghost_pad_setcaps_default (GstPad * pad, GstCaps * caps)
|
||||
|
|
|
|||
|
|
@ -430,7 +430,7 @@ gst_mini_object_unref (GstMiniObject * mini_object)
|
|||
* (gst_mini_object_ref() adds a strong reference, that is, forces the object
|
||||
* to stay alive).
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
void
|
||||
gst_mini_object_weak_ref (GstMiniObject * object,
|
||||
|
|
@ -479,7 +479,7 @@ found:
|
|||
*
|
||||
* Removes a weak reference callback to a mini object.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
void
|
||||
gst_mini_object_weak_unref (GstMiniObject * object,
|
||||
|
|
|
|||
|
|
@ -146,7 +146,7 @@ typedef enum
|
|||
* called, there's not much you could do with the object, apart from e.g. using
|
||||
* its adress as hash-index or the like.
|
||||
*
|
||||
* Since: 0.10.34
|
||||
* Since: 0.10.35
|
||||
*
|
||||
*/
|
||||
typedef void (*GstMiniObjectWeakNotify) (gpointer data,
|
||||
|
|
|
|||
|
|
@ -1023,7 +1023,7 @@ gst_input_selector_class_init (GstInputSelectorClass * klass)
|
|||
* buffers are dropped by input-selector that might be needed
|
||||
* when switching the active pad.
|
||||
*
|
||||
* Since: 0.10.33
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
g_object_class_install_property (gobject_class, PROP_SYNC_STREAMS,
|
||||
g_param_spec_boolean ("sync-streams", "Sync Streams",
|
||||
|
|
|
|||
|
|
@ -410,7 +410,7 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
|
|||
* streams by keeping the order in which buffers and events arrived compared
|
||||
* to active and linked streams.
|
||||
*
|
||||
* Since: 0.10.33
|
||||
* Since: 0.10.35
|
||||
*/
|
||||
g_object_class_install_property (gobject_class, PROP_SYNC_BY_RUNNING_TIME,
|
||||
g_param_spec_boolean ("sync-by-running-time", "Sync By Running Time",
|
||||
|
|
|
|||
Loading…
Reference in a new issue